Use README as index for documentation

This commit is contained in:
François Voron
2019-10-20 10:23:46 +02:00
parent e146e4bca4
commit f337bf1491
3 changed files with 15 additions and 40 deletions

View File

@ -1,29 +1 @@
# FastAPI Users
<p align="center">
<img src="https://raw.githubusercontent.com/frankie567/fastapi-users/master/logo.svg?sanitize=true" alt="FastAPI Users">
</p>
<p align="center">
<em>Ready-to-use and customizable users management for FastAPI</em>
</p>
---
**Documentation**: <a href="https://frankie567.github.io/fastapi-users/" target="_blank">https://frankie567.github.io/fastapi-users/</a>
**Source Code**: <a href="https://github.com/frankie567/fastapi-users" target="_blank">https://github.com/frankie567/fastapi-users</a>
---
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!}