Skip to content

Commit edf723f

Browse files
authored
Update index.md
1 parent f25f71a commit edf723f

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<a href="#" target="blank"><img src="img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
44
</p>
55

6-
<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 RESTAPIs and server-side applications. </p>
77

88
![Test](https://github.com/python-ellar/ellar/actions/workflows/test_full.yml/badge.svg)
99
![Coverage](https://img.shields.io/codecov/c/github/python-ellar/ellar)
@@ -19,16 +19,16 @@ Ellar is a lightweight ASGI framework designed to simplify the development of ef
1919
applications. Whether you're building web services, APIs, or full-fledged web applications,
2020
Ellar offers a high level of abstraction and powerful features to streamline your development process.
2121

22-
Ellar provides developers with the flexibility to embrace both Object-Oriented Programming (OOP) and Functional Programming (FP) paradigms.
23-
It is built on top of Starlette, a renowned ASGI toolkit, ensuring robust asynchronous request handling capabilities.
22+
Ellar allows developers to embrace both Object-Oriented Programming (OOP) and Functional Programming (FP) paradigms.
23+
It is built on top of Starlette, a renowned ASGI toolkit, ensuring robust asynchronous request-handling capabilities.
2424

2525
## **Key Features**
2626

2727
- **Easy to Use**: With an intuitive API, Ellar makes it easy for developers to get started with building fast and scalable Python web applications.
2828
- **Dependency Injection (DI)**: Ellar includes a built-in DI system, enabling easy management of dependencies and reducing coupling between components.
2929
- **Pydantic Integration**: Integrated with Pydantic for seamless data validation, ensuring that input data is always valid.
3030
- **Templating with Jinja2**: Built-in support for Jinja2 templates simplifies the creation of dynamic web pages.
31-
- **OpenAPI Documentation**: Ellar comes with built-in support for generating OpenAPI documentation, facilitating API documentation generation with Swagger or ReDoc.
31+
- **OpenAPI Documentation**: Ellar has built-in support for generating OpenAPI documentation and facilitating API documentation generation with Swagger or ReDoc.
3232
- **Controller (MVC) Architecture**: Ellar follows the Model-View-Controller (MVC) pattern, aiding in organizing code and separating concerns.
3333
- **Guards for Authentication and Authorization**: Offers built-in support for guards, making it easy to implement authentication and authorization in applications.
3434
- **Modularity**: Inspired by NestJS, Ellar follows a modular architecture, allowing developers to organize code into reusable modules.
@@ -114,7 +114,7 @@ document_builder.set_title('Ellar API') \
114114
document = document_builder.build_document(app)
115115

116116
# Setup OpenAPI documentation module
117-
module = OpenAPIDocumentModule.setup(
117+
OpenAPIDocumentModule.setup(
118118
app=app,
119119
docs_ui=SwaggerUI(),
120120
document=document,
@@ -126,12 +126,14 @@ if __name__ == "__main__":
126126
uvicorn.run("main:app", port=5000, reload=True)
127127
```
128128

129-
## **Project Status**
130129

131-
Currently, Ellar is in beta version with the following status:
130+
Now we can test our API at [http://127.0.0.1:5000/docs](http://127.0.0.1:5000/docs#/)
132131

133-
- Documentation: 95% complete
134-
- Authentication and Authorization: In progress
132+
You can also try the [quick-project](https://python-ellar.github.io/ellar/quick-project/) setup to get a good idea of the library.
133+
134+
135+
## **Project Documentation Status**
136+
- Authorization: In progress
135137

136138
## **Dependency Summary**
137139

0 commit comments

Comments
 (0)