Skip to content

Commit 2d2677b

Browse files
authored
Update README.md
1 parent 06de9fd commit 2d2677b

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
11
<p align="center">
2-
<a href="#" target="blank"><img src="docs/img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
2+
<a href="#" target="blank"><img src="https://eadwincode.github.io/ellar/img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
33
</p>
4+
<p align="end">logo by: <a target="_blank" href="https://www.behance.net/azadvertised">Azad</a></p>
45

5-
<p align="center"> Ellar - Python ASGI web framework for building fast, efficient and scalable RESTAPIs and server-side application. </p>
6+
<p align="center"> Ellar - Python ASGI web framework for building fast, efficient and scalable RESTful APIs and server-side application. </p>
67

78
![Test](https://github.com/eadwinCode/ellar/actions/workflows/test_full.yml/badge.svg)
89
![Coverage](https://img.shields.io/codecov/c/github/eadwinCode/ellar)
910
[![PyPI version](https://badge.fury.io/py/ellar.svg)](https://badge.fury.io/py/ellar)
1011
[![PyPI version](https://img.shields.io/pypi/v/ellar.svg)](https://pypi.python.org/pypi/ellar)
1112
[![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
1213

14+
## Project Status
15+
Beta version
16+
- Documentation - 95% complete
17+
- Authentication and Authorization - (in progress)
18+
19+
1320
## **Introduction**
1421

1522
Ellar is a lightweight ASGI framework for building efficient and scalable server-side python applications.
@@ -49,7 +56,7 @@ For normal pip installation
4956
pip install ellar-cli
5057
```
5158

52-
## Creating a project
59+
## **Creating a project**
5360
To create an ellar project, you need to have a `pyproject.toml` available on your root directory.
5461
This is necessary for ellar to store some `metadata` about your project.
5562

@@ -71,7 +78,7 @@ ellar runserver --reload
7178
`--reload` is to watch for file changes
7279

7380
Now go to [http://127.0.0.1:8000](http://127.0.0.1:8000)
74-
![Swagger UI](docs/img/ellar_framework.png)
81+
![Swagger UI](https://eadwincode.github.io/ellar/img/ellar_framework.png)
7582

7683
For more info on Ellar CLI, click [here](https://github.com/eadwinCode/ellar-cli)
7784

@@ -273,7 +280,7 @@ application.install_module(module)
273280

274281
Now we can test our API at [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs#/)
275282
Please ensure your server is running
276-
![Swagger UI](docs/img/car_api.png)
283+
![Swagger UI](https://eadwincode.github.io/ellar/img/car_api.png)
277284

278285
## **HTML Templating**
279286
Ellar has built-in support for Jinja2, which is a popular template engine for HTML. This feature allows for easy and efficient HTML templating similar to that of Flask. Jinja2 can be used to create reusable templates, and to insert dynamic data into HTML pages. It also has support for template inheritance, control structures, and other useful features that can help to simplify and streamline the process of creating HTML templates.
@@ -291,8 +298,3 @@ Ellar has built-in support for Jinja2, which is a popular template engine for HT
291298
```
292299

293300
See the [Doc](https://eadwincode.github.io/ellar/templating/templating/) for more examples.
294-
295-
## Project Status
296-
Project is still in development
297-
- Documentation - (in progress)
298-
- Database Plugin with [Encode/ORM](https://github.com/encode/orm)

0 commit comments

Comments
 (0)