Skip to content

Commit 4cb60f4

Browse files
committed
GH-4: Add the common README sections
1 parent 38397b0 commit 4cb60f4

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
# fastapi-oauth2
1+
# fastapi-oauth2 <img src="https://github.com/pysnippet.png" align="right" height="64" />
22

3-
Easy to setup OAuth2 social authentication mechanism with support for several auth providers.
3+
Easy to setup OAuth2 authentication with support for several auth providers.
44

5-
## Features
5+
## Installation
6+
7+
```shell
8+
python -m pip install fastapi-oauth2
9+
```
10+
11+
## Features to be implemented
612

7-
- Integrate with any existing FastAPI project (no dependencies of the project should stop the work of
8-
the `fastapi-oauth2`)
9-
* Implementation must allow to provide a context for configurations (also, see how it is done in another projects)
1013
- Use multiple OAuth2 providers at the same time
1114
* There need to be provided a way to configure the OAuth2 for multiple providers
1215
- Token -> user data, user data -> token easy conversion
1316
- Customize OAuth2 routes
17+
18+
## Contribute
19+
20+
Any contribution is welcome. If you have any ideas or suggestions, feel free to open an issue or a pull request. And
21+
don't forget to add tests for your changes.
22+
23+
## License
24+
25+
Copyright (C) 2023 Artyom Vancyan. [MIT](https://github.com/pysnippet/fastapi-oauth2/blob/master/LICENSE)

0 commit comments

Comments
 (0)