Use README as index for documentation

README.md

@@ -21,16 +21,18 @@
 
 ---
 
-## Work in progress 🚧
+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.
-
-This library is currently in early stage development. First working version soon!
 
 ## Features
 
-* Extensible base user model
+* [X] Extensible base user model
-* Ready-to-use register, login, forgot and reset password routes.
+* [X] Ready-to-use register, login, forgot and reset password routes.
-* Customizable database backend
+* [X] Customizable database backend
-    * SQLAlchemy backend included
+    * [X] SQLAlchemy backend included
-    * *MongoDB backend included ([#4](https://github.com/frankie567/fastapi-users/issues/4))*
+    * [ ] MongoDB backend included ([#4](https://github.com/frankie567/fastapi-users/issues/4))
-* Customizable authentication backend
+* [X] Customizable authentication backend
-    * JWT authentication backend included
+    * [X] JWT authentication backend included
+
+## License
+
+This project is licensed under the terms of the MIT license.

docs/index.md

@@ -1,29 +1 @@
-# FastAPI Users
+{!../README.md!}
-
-<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

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