Improve readme

Author: kalekseev

README.md

@@ -1,6 +1,37 @@
 # Django Extra Checks
 
-Useful checks for Django Checks Frameworks
+Collection of useful checks for Django Checks Frameworks
+
+## Checks
+
+### Models
+
+- **extra-checks-config** - settings.EXTRA_CHECKS is valid config for django-extra-checks (always enabled).
+- **model-attribute** - Each Model in the project must have all attributes from `attrs` setting specified.
+- **model-meta-attribute** - Each Model.Meta in the project must have all attributes from `attrs` setting specified.
+- **no-unique-together** - Use UniqueConstraint with the constraints option instead.
+- **no-index-together** - Use the indexes option instead.
+- **model-admin** - Each model must be registered in admin.
+- **field-file-upload-to** - FileField/ImageField must have non empty `upload_to` argument.
+- **field-verbose-name** - All model's fields must have verbose name.
+- **field-verbose-name-gettext** - verbose_name must use gettext.
+- **field-verbose-name-gettext-case** - Words in text wrapped with gettext must be in one case.
+- **field-help-text-gettext** - help_text must use gettext.
+- **field-text-null** - text fields shouldn't use `null=True`.
+- **field-boolean-null** - prefer using `BooleanField(null=True)` instead of `NullBooleanField`.
+- **field-null** - don't pass `null=False` to model fields (this is django default).
+- **field-foreign-key-db-index** - ForeignKey fields must specify `db_index` explicitly (to apply only to fields in indexes: `when: indexes`).
+- **field-default-null** - If field nullable (`null=True`), then
+  `default=None` argument is redundant and should be removed.
+  **WARNING** Be aware that setting is database dependent,
+  eg. Oracle interprets empty strings as nulls as a result
+  django uses empty string instead of null as default.
+- **field-choices-constraint** - Fields with choices must have companion CheckConstraint to enforce choices on database level, [details](https://adamj.eu/tech/2020/01/22/djangos-field-choices-dont-constrain-your-data/).
+
+### DRF Serializers
+
+- **drf-model-serializer-extra-kwargs** - ModelSerializer's extra_kwargs must not include fields that specified on serializer.
+- **drf-model-serializer-meta-attribute** - Each ModelSerializer.Meta must have all attributes specified in `attrs`, [use case](https://hakibenita.com/django-rest-framework-slow#bonus-forcing-good-habits).
 
 ## Settings
 
@@ -80,37 +111,6 @@ EXTRA_CHECKS = {
 }
 ```
 
-## Checks
-
-### Models
-
-- **extra-checks-config** - settings.EXTRA_CHECKS is valid config for django-extra-checks (always enabled).
-- **model-attribute** - Each Model in the project must have all attributes from `attrs` setting specified.
-- **model-meta-attribute** - Each Model.Meta in the project must have all attributes from `attrs` setting specified.
-- **no-unique-together** - Use UniqueConstraint with the constraints option instead.
-- **no-index-together** - Use the indexes option instead.
-- **model-admin** - Each model must be registered in admin.
-- **field-file-upload-to** - FileField/ImageField must have non empty `upload_to` argument.
-- **field-verbose-name** - All model's fields must have verbose name.
-- **field-verbose-name-gettext** - verbose_name must use gettext.
-- **field-verbose-name-gettext-case** - Words in text wrapped with gettext must be in one case.
-- **field-help-text-gettext** - help_text must use gettext.
-- **field-text-null** - text fields shouldn't use `null=True`.
-- **field-boolean-null** - prefer using `BooleanField(null=True)` instead of `NullBooleanField`.
-- **field-null** - don't pass `null=False` to model fields (this is django default).
-- **field-foreign-key-db-index** - ForeignKey fields must specify `db_index` explicitly (to apply only to fields in indexes: `when: indexes`).
-- **field-default-null** - If field nullable (`null=True`), then
-  `default=None` argument is redundant and should be removed.
-  **WARNING** Be aware that setting is database dependent,
-  eg. Oracle interprets empty strings as nulls as a result
-  django uses empty string instead of null as default.
-- **field-choices-constraint** - Fields with choices must have companion CheckConstraint to enforce choices on database level, [details](https://adamj.eu/tech/2020/01/22/djangos-field-choices-dont-constrain-your-data/).
-
-### DRF Serializers
-
-- **drf-model-serializer-extra-kwargs** - ModelSerializer's extra_kwargs must not include fields that specified on serializer.
-- **drf-model-serializer-meta-attribute** - Each ModelSerializer.Meta must have all attributes specified in `attrs`, [use case](https://hakibenita.com/django-rest-framework-slow#bonus-forcing-good-habits).
-
 ## Development
 
 Install dev deps in virtualenv `pip install -e .[dev]`.