diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4a405f7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# Contributing + +## Installation + +Download the development dependencies by using `pip install -r requirements-dev.txt`. + +## Updating dependencies +You can manually update dependencies by: +```bash +pip-compile pyproject.toml -o requirements.txt --strip-extras +pip-compile pyproject.toml --extra dev -o requirements-dev.txt --strip-extras +``` diff --git a/README.md b/README.md index d636536..0d6e7ad 100644 --- a/README.md +++ b/README.md @@ -42,14 +42,3 @@ def protected_route(request: Request): user = token.user() # user has information, like `user.id()` and `user.full_name()`. ``` - -## Contributing - -Download the development dependencies by using `pip install -r requirements-dev.txt`. - -### Updating dependencies -You can manually update dependencies by: -```bash -pip-compile pyproject.toml -o requirements.txt --strip-extras -pip-compile pyproject.toml --extra dev -o requirements-dev.txt --strip-extras -```