diff --git a/README b/README deleted file mode 100755 index 8068cc0ffc6d8eef8e2d39db677656878dc928ec..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,57 +0,0 @@ -Description -=========== -phpipam is an open-source web IP address management application. Its goal is to provide light and simple IP address management application. -It is ajax-based using jQuery libraries, it uses php scripts and javascript and some HTML5/CSS3 features, so some modern browser is preferred -to be able to display javascript quickly and correctly. - -Features and tools: -- https://phpipam.net/documents/features/ - -License -======= -phpipam is released under the GPL v3 license, see misc/gpl-3.0.txt. - -Requirements -============ -- https://phpipam.net/documents/installation/ - -Install -======= -- https://phpipam.net/documents/installation/ - -API guide -========= -- https://phpipam.net/api-documentation/ - -Update -======= -- https://phpipam.net/documents/upgrade/ - -Demo page -============ -http://demo.phpipam.net - -Default user -============ -Admin / ipamadmin - -Reset admin password -==================== -php functions/scripts/reset-admin-password.php - -Changelog -========= -See misc/CHANGELOG - -Roadmap -========= -See misc/Roadmap - -Contact -======= -miha.petkovsek@gmail.com - -special thank also to Hosterdam team (http://www.hosterdam.com) for VPS server -that is used for development of phpIPAM and for demo site. - -And also to all users that filed a bug report / feature report and helped with feature testing! diff --git a/README.md b/README.md new file mode 100755 index 0000000000000000000000000000000000000000..474bc9aa8abe5620ab2a36d6a636fce328870ec0 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# php{ip}am +Website: https://phpipam.net/ + +## Description +phpipam is an open-source web IP address management application. Its goal is to provide light and simple IP address management application. +It is ajax-based using jQuery libraries, it uses php scripts and javascript and some HTML5/CSS3 features, so some modern browser is preferred +to be able to display javascript quickly and correctly. + +## Links + - [Features & Tools](https://phpipam.net/documents/features/) + - [Requirements & Installation](https://phpipam.net/documents/installation/) + - [API guide](https://phpipam.net/api-documentation/) + - [Update](https://phpipam.net/documents/upgrade/) + - [Demo page](http://demo.phpipam.net) (Login: `Admin / ipamadmin`) + +## I forgot my Admin password!? +Just run `php functions/scripts/reset-admin-password.php` in the cliandand enter your new password + +## What are the credentials for a fresh install? +The Default redentials for a new instance of phpipam are the same as the credentils for +the demo page: `Admin / ipamadmin` + +## Changelog +See misc/CHANGELOG + +## Roadmap +See misc/Roadmap + +## Contact +miha.petkovsek@gmail.com + +Special thanks are going also to the Hosterdam team (http://www.hosterdam.com) for the VPS server +that is used for development of phpIPAM and for demo site. + +And also to all users that filed a bug report / feature report and helped with feature testing! + +## License +phpipam is released under the GPL v3 license, see misc/gpl-3.0.txt.