Move readme to markdown (#9)

* Move readme to markdown

* Fix README.md

README.rst → README.md

@@ -1,6 +1,5 @@
-===============
-Liquidb
-===============
+# Liquidb
+
 
 Liquidb is a Django app that simplifies migration management.
 It introduces commits (savepoints) that allows developer to take snapshot of current migration state of whole Django project.
@@ -9,16 +8,14 @@ In order to roll(back/forward) all migrations should be revertable.
 
 
 
-Requirements
-============
+## Requirements
 
 Django Liquidb requires:
     * Django 3.2 or later;
     * Python 3.8 or later.
 
 
-Getting It
-==========
+### Getting It
 
 You can get Django Liquidb by using pip::
 
@@ -32,22 +29,22 @@ If you want to install it from source, grab the git repository from GitHub and r
 
 
 
-Quick start
------------
+### Quick start
 
-1. Add "Liquidb" to your INSTALLED_APPS setting like this::
 
+1. Add "Liquidb" to your INSTALLED_APPS setting like this:
+   ```
     INSTALLED_APPS = [
         ...
         'liquidb',
     ]
+   ```
 
+3. Run ``python manage.py migrate liquidb`` to create the liquidb models.
+4. Create initial commit ``python manage.py create_migration_snapshot --name init``
 
-2. Run ``python manage.py migrate liquidb`` to create the liquidb models.
-3. Create initial commit ``python manage.py create_migration_snapshot --name init``
+### Using It
 
-Using It
------------
 
 Create snapshot of your current state::
 
@@ -83,20 +80,19 @@ Or if you prefer admin vies you can always visit `/admin/liquidb/snapshot/` and
 > If you would like to change to readonly view in admin please change ADMIN_SNAPSHOT_ACTIONS env variable to False or overwrite it you settings
 
 
-Getting Involved
-================
+## Getting Involved
+
 
 Open Source projects can always use more help. Fixing a problem, documenting a feature, adding
 translation in your language. If you have some time to spare and like to help us, here are the places to do so:
 
 - GitHub: https://github.com/Gusakovskiy/django-liquidb
 
 
-Development
-==========
+### Development
 
-Generating dependencies
------------
+
+#### Generating dependencies
 
 Main dependencies::
 
@@ -113,8 +109,8 @@ After generating dependencies remember to change `backports.zoneinfo==0.2.1` to
 this dependency is not supported by Python >= 3.9, it should be deleted after support for those versions is ended.
 
 
-Configure environment
------------
+### Configure environment
+
 
 In you local machine create virtual environment and activate it or setup docker container and run command::
 
@@ -128,11 +124,10 @@ To run linting::
 
     $ pylint --load-plugins=pylint_django --django-settings-module=liquidb.pylint_settings liquidb
 
-Support
-=======
+## Support
 
 Django Liquidb is development and maintained by developers in an Open Source manner.
 Any support is welcome. You could help by writing documentation, pull-requests, report issues and/or translations.
 
 Please remember that nobody is paid directly to develop or maintain Django Liquidb so we do have to divide our time
-between work/family/hobby/this project and the rest of life.
+between work/family/hobby/this project and the rest of life.

pyproject.toml

@@ -2,7 +2,7 @@
 name = "django-liquidb"
 version = "0.4"
 description = "Liquidb is a Django app that simplifies migration management."
-readme = "README.rst"
+readme = "README.md"
 dependencies = [
     "django>=3.2"
 ]