update readme

Author: freenoth

README.md

@@ -1 +1,108 @@
-Test
+# Django auto rollback
+This package allow to easily manage apps migrations based on GIT repository (it use commits to store apps state).
+So you can easily return to any previous state that is stored in DB by one command.
+
+## Version
+This is the first release of package. Current version is `0.1.0`
+
+It works with:
+- django == 1.11
+- GitPython >= 2.1.8
+- PostgreSQL
+
+## Installing
+
+First yoy need to install package with pip:
+```bash
+pip install git+https://bitbucket.gcore.lu/scm/~aleksey.yakovlev_gcore.lu/django-auto-rollback.git@0.1.0
+```
+
+Then install it to your `INSTALLED_APPS`
+```python
+INSTALLED_APPS = [
+    # ...
+    'django_rollback',
+]
+```
+
+You are also should execute `./manage.py migrate` before using additional management commands.
+
+## Using
+There is only two commands to manage migrations state:
+
+### Storing current state
+```bash
+./manage.py store_migrations_state
+```
+This command used to store current commit state to DB (it create new or update existing state).
+
+Successful output example below:
+```bash
+Data = [(4, 'admin', '0002_logentry_remove_auto_add'), (12, 'auth', '0008_alter_user_username_max_length'), (5, 'contenttypes', '0002_remove_content_type_name'), (16, 'django_auto_rollback', '0001_initial'), (17, 'django_rollback', '0001_initial'), (14, 'sessions', '0001_initial')].
+Successfully created for commit "84e47461a95fa325d9e933bbe8cca8c52bbea203".
+```
+
+### Return to previous state
+```bash
+./manage.py rollback_migrations
+```
+Help message below:
+```bash
+usage: manage.py rollback_migrations [-t TAG] [-c COMMIT] [--fake]
+
+Rollback migrations state of all django apps to chosen tag or commit if
+previously stored.
+
+optional arguments:
+  -t TAG, --tag TAG     Git tag in witch needs to rollback migrations.
+  -c COMMIT, --commit COMMIT
+                        Git commit hash in witch needs to rollback migrations.
+  --fake                Used to block migrate commands execution, so it allow
+                        to only print info about processed actions without
+                        execution.
+```
+
+You can use git commit hash (hex) directly.
+You don`t need to specify full commit hash, you just can use first letters.
+The commands below are equal:
+```bash
+./manage.py rollback_migrations -c 0e02e741c5953212428adc1cac9060b2a0b8626b
+./manage.py rollback_migrations -c 0e02e74
+./manage.py rollback_migrations --commit 0e02e74
+```
+Or you can use git tag (it will be translated to related commit).
+```bash
+./manage.py rollback_migrations -t v.0.0.1
+./manage.py rollback_migrations --tag v.0.0.2
+```
+
+Either tag or commit argument is required:
+```bash
+./manage.py rollback_migrations
+CommandError: Tag or commit should be described by -t or -c arguments.
+```
+And it can`t be used together:
+```bash
+./manage.py rollback_migrations -c 0e02e74  -t v.0.0.1
+CommandError: Tag and commit arguments should not be described together.
+```
+
+Successful output example below:
+```bash
+./manage.py rollback_migrations -c c257a23
+>>> Executing command: migrate django_rollback zero
+Operations to perform:
+  Unapply all migrations: django_rollback
+Running migrations:
+  Rendering model states... DONE
+  Unapplying django_rollback.0001_initial... OK
+Rollback successfully finished.
+```
+
+As you can see above, apps can be rollbacked to `zero` state too, if in previous state this app not used.
+
+### Successful rollback conditions
+So rollback will be successfully finished if two conditions are satisfied:
+- state for current commit are stored (if not - use `./manage.py store_migrations_state` command)
+- state for specified commit or commit witch relates to specified tag was stored in the past
+