From db567916a83492fa4123b10afb7c7ab3c6695404 Mon Sep 17 00:00:00 2001
From: THEBAULT Julien <julien.thebault@numberly.com>
Date: Tue, 17 Sep 2024 14:30:24 +0200
Subject: [PATCH] docs(README): add contributing part

---
 README.md      | 42 +++++++++++++++++++++++++++++++++---------
 pyproject.toml |  5 +++++
 2 files changed, 38 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 2b2f6f4..1d4f345 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,10 @@ There are 2 types of clients:
 The `reset_account` and `transfer_account_rights` from the Admin client needs a valid Bitwarden client to re-invite the
 target user.
 
+## Installation
+```bash
+pip install python-vaultwarden
+```
 ## Usage
 
 ### Admin client
@@ -76,15 +80,6 @@ if my_user:
 
 ```
 
-## TODO
-- [ ] Add tests form Vaultwarden admin client
-- [ ] Rewrite crypto part to remove dependency on bitwardentools and add argon2id support
-- [ ] Support email + password authentication
-- [ ] Support end user operations
-- [ ] Ciphers management support
-- [ ] Many other things I didn't think of yet
-
-
 ## Credits
 
 The [crypto part](src/vaultwarden/utils/crypto.py) originates from [bitwardentools](https://github.com/corpusops/bitwardentools).
@@ -101,6 +96,35 @@ The [crypto part](src/vaultwarden/utils/crypto.py) originates from [bitwardentoo
 [GHAction-link]: https://github.com/numberly/python-vaultwarden/actions?query=event%3Apush+branch%3Amain
 <!-- Links -->
 
+
+## Contributing
+Thank you for being interested in contributing to `python-vaultwarden`. There are many ways you can contribute to the project:
+  - Try and report bugs/issues you find
+  - Implement new features
+  - Review Pull Requests of others
+  - Write documentation
+  - Participate in discussions
+
+### Development
+To start developing create a fork of the python-vaultwarden repository on GitHub.
+
+Then clone your fork with the following command replacing YOUR-USERNAME with your GitHub username:
+
+```bash
+git clone https://github.com/YOUR-USERNAME/python-vaultwarden
+```
+
+You can now install the project and its dependencies using:
+```bash
+pip install -e .[test]
+```
+### Testing
+To run the tests, use:
+
+```bash
+bash tests/e2e/run_tests.sh
+```
+
 ## License
 
 Python-vaultwarden is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
diff --git a/pyproject.toml b/pyproject.toml
index afcf594..e46d87d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -39,6 +39,11 @@ dependencies = [
     "pydantic >=2.5.0",
     "httpx >=0.24.1",
 ]
+[dev-dependencies]
+test = [
+  "hatch==1.12.0",
+  "pytest==8.3.3",
+]
 
 [tool.hatch.version]
 path = "src/vaultwarden/__version__.py"