Skip to content

Commit b11f6b2

Browse files
authored
Update README.md
1 parent 080e07e commit b11f6b2

File tree

1 file changed

+21
-30
lines changed

1 file changed

+21
-30
lines changed

README.md

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,27 @@
1010
[![PyPI version](https://img.shields.io/pypi/v/ellar.svg)](https://pypi.python.org/pypi/ellar)
1111
[![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
1212

13-
## Features Summary
14-
- `Pydantic integration`
15-
- `Dependency Injection (DI)`
16-
- `Templating with Jinja2`
17-
- `OpenAPI Documentation (Swagger and ReDoc)`
18-
- `Controller (MVC)`
19-
- `Guards (authentications, roles and permissions)`
20-
- `Modularization (eg: flask blueprint)`
21-
- `Websocket support`
22-
- `Session and Cookie support`
23-
- `CORS, GZip, Static Files, Streaming responses`
13+
## Introduction
14+
15+
Ellar is a lightweight ASGI framework for building efficient and scalable server-side python applications.
16+
It supports both OOP (Object-Oriented Programming) and FP (Functional Programming)
17+
18+
Ellar is based on [Starlette (ASGI toolkit)](https://www.starlette.io/), a lightweight ASGI framework/toolkit well-suited for developing asynchronous web services in Python.
19+
While Ellar provides a high level of abstraction on top of Starlette, it still incorporates some of its features, as well as those of FastAPI.
20+
If you are familiar with these frameworks, you will find it easy to understand and use Ellar.
21+
22+
## 💝 Special Thanks
23+
24+
This project is built with
25+
26+
- [Starlette](https://www.starlette.io/)
27+
- Starlette is a lightweight ASGI framework/toolkit, which is ideal for building async web services in Python.
28+
29+
- [Pydantic](https://docs.pydantic.dev/)
30+
- Data validation and settings management using Python type annotations.
31+
32+
- [Injector](https://github.com/python-injector/injector)
33+
- Python dependency injection framework, inspired by Guice
2434

2535
## Requirement
2636
- Python >= 3.7
@@ -43,12 +53,6 @@ Some shells may treat square braces (`[` and `]`) as special characters. If that
4353
pip install "ellar[standard]"
4454
```
4555

46-
### Py36 Support
47-
For python3.6 users,
48-
```shell
49-
pip install ellar==0.2.2
50-
```
51-
5256
## Create a project
5357
To create an ellar project, you need to have a `pyproject.toml` available on your root directory.
5458
This is necessary for ellar to store some `metadata` about your project.
@@ -301,19 +305,6 @@ Project is still in development
301305
- Caching
302306
- API Throttling
303307

304-
## 💝 Special Thanks
305-
306-
This project is built with
307-
308-
- [Starlette](https://www.starlette.io/)
309-
- Starlette is a lightweight ASGI framework/toolkit, which is ideal for building async web services in Python.
310-
311-
- [Pydantic](https://docs.pydantic.dev/)
312-
- Data validation and settings management using Python type annotations.
313-
314-
- [Injector](https://github.com/python-injector/injector)
315-
- Python dependency injection framework, inspired by Guice
316-
317308
## ⭐ Ellar Star Lords
318309

319310
Many thanks to the kind individuals who leave a star.

0 commit comments

Comments
 (0)