diff --git a/README.md b/README.md index d4a123d..fffd4e0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,45 @@ -# django-user-authentication +# Django-consul-tree -To run the application in your development environment +Tree representation of hashicorp/consul https://www.consul.io/, https://github.com/hashicorp/consul KV section. + +**Used Technologies:** Python, Django, HTML, CSS, JS, JsTree, JQuery, Twitter Bootstrap. + +**UI/UX:** (Desktop, Tablet, Mobile) friendly - responsive (80+%). + +----------------- + +**Supported Methods:** + +**Available Features:** + +***Latest Features:*** + +Quick Start +----------- +To use the Consul-tree you need Python and a web server. + +- Clone the repo into your web directory. +- After you pull you should execute the following to update the DB +``` +python manage.py migrate +``` +- Create Your Super User(Admin) and follow the instructions +``` +python manage.py createsuperuser +``` +- Run the application in your development environment and go http://yourserver/admin ``` python manage.py runserver ``` +- Create new user from admin panel +- Go http://yourserver and login with new user -After you pull you should execute the following to update the DB -```bash -python manage.py migrate -``` \ No newline at end of file +Issues / Features request tracker +----------- +Found an issue or have a feature request ? + +Please create an issue [here](https://github.com/vagharsh/django-consul-tree/issues). + +Copyright and License +--------------------- +Copyright and License under the [Apache-2.0](LICENSE).