Merge pull request #43 from eadwinCode/documentation-volume-1

Documentation volume 1

Author: eadwinCode

.pre-commit-config.yaml

@@ -14,14 +14,14 @@ repos:
       name: Code Formatting
       entry: "make fmt"
       types: [python]
-      language_version: python3.6
+      language_version: python3.8
       language: python
     - id: code_linting
       args: [ ]
       name: Code Linting
       entry: "make lint"
       types: [ python ]
-      language_version: python3.6
+      language_version: python3.8
       language: python
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v2.3.0

README.md

@@ -10,28 +10,23 @@
 [![PyPI version](https://img.shields.io/pypi/v/ellar.svg)](https://pypi.python.org/pypi/ellar)
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
 
-## Features
-- Pydantic integration
-- Dependency Injection (DI)
-- Templating with Jinja2
-- OpenAPI Documentation (Swagger and ReDoc)
-- Controller (MVC)
-- Guards (Authentications, roles and permissions)
-- Modularization (eg: flask blueprint)
-- Websocket support
-- Session and Cookie support
-- CORS, GZip, Static Files, Streaming responses
-- Test client built on `requests`
-- In-process background tasks.
-- Startup and shutdown events.
-- Application Events
-- Compatible with `asyncio` and `trio` backends.
-
-## Requirements
-- Python >= 3.7
-- Starlette
-- Pydantic
-- Injector
+## Features Summary
+- `Pydantic integration`
+- `Dependency Injection (DI)`
+- `Templating with Jinja2`
+- `OpenAPI Documentation (Swagger and ReDoc)`
+- `Controller (MVC)`
+- `Guards (authentications, roles and permissions)`
+- `Modularization (eg: flask blueprint)`
+- `Websocket support`
+- `Session and Cookie support`
+- `CORS, GZip, Static Files, Streaming responses`
+
+## Dependency Summary
+- `Python >= 3.7`
+- `Starlette`
+- `Pydantic`
+- `Injector`
 
 ## Installation
 ### Poetry Installation