diff --git a/README.md b/README.md index 30b6435e..28f5fd9b 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,18 @@ --- -## Work in progress 🚧 - -This library is currently in early stage development. First working version soon! +Add quickly a registration and authentication system to your [FastAPI](https://fastapi.tiangolo.com/) project. **FastAPI Users** is designed to be as customizable and adaptable as possible. ## Features -* Extensible base user model -* Ready-to-use register, login, forgot and reset password routes. -* Customizable database backend - * SQLAlchemy backend included - * *MongoDB backend included ([#4](https://github.com/frankie567/fastapi-users/issues/4))* -* Customizable authentication backend - * JWT authentication backend included +* [X] Extensible base user model +* [X] Ready-to-use register, login, forgot and reset password routes. +* [X] Customizable database backend + * [X] SQLAlchemy backend included + * [ ] MongoDB backend included ([#4](https://github.com/frankie567/fastapi-users/issues/4)) +* [X] Customizable authentication backend + * [X] JWT authentication backend included + +## License + +This project is licensed under the terms of the MIT license. diff --git a/docs/index.md b/docs/index.md index 18b07f4b..7d211af2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,29 +1 @@ -# FastAPI Users - -

- FastAPI Users -

- -

- Ready-to-use and customizable users management for FastAPI -

- ---- - -**Documentation**: https://frankie567.github.io/fastapi-users/ - -**Source Code**: https://github.com/frankie567/fastapi-users - ---- - -Add quickly a registration and authentication system to your [FastAPI](https://fastapi.tiangolo.com/) project. **FastAPI Users** is designed to be as customizable and adaptable as possible. - -## Features - -* Extensible base user model -* Ready-to-use register, login, forgot and reset password routes. -* Customizable database backend - * SQLAlchemy backend included - * *MongoDB backend included ([#4](https://github.com/frankie567/fastapi-users/issues/4))* -* Customizable authentication backend - * JWT authentication backend included +{!../README.md!} diff --git a/mkdocs.yml b/mkdocs.yml index f01c4a32..5071b7a4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,9 +22,10 @@ markdown_extensions: - admonition - codehilite - pymdownx.superfences + - pymdownx.tasklist nav: - - index.md + - About: index.md - installation.md - Configuration: - configuration/model.md