From c4363776699d865aa5f3c56009e96fdb4856ae9f Mon Sep 17 00:00:00 2001
From: Kumi <git@kumi.email>
Date: Fri, 26 Apr 2024 12:04:41 +0200
Subject: [PATCH] feat(plankapy): add installation and usage guidelines

Revised the README.md to include comprehensive sections on installation and usage, providing a clear path for users to get started with plankapy. Additionally, updates were made to highlight the fork's aim of making plankapy pip installable and ensuring compatibility with a wider range of Python versions by adjusting the requires-python version from >=3.10 to >=3.8 in pyproject.toml. This expansion not only increases accessibility for developers using older Python versions but also aligns with our goal to make the project more inclusive and user-friendly.
---
 README.md      | 35 ++++++++++++++++++++++++++++++-----
 pyproject.toml |  2 +-
 2 files changed, 31 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 489d7fb..da6f16e 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,44 @@
 # plankapy
+
 A python 3 based API for controlling a self-hosted Planka instance
 
 This is a fork of the original [plankapy](https://github.com/hwelch-fle/plankapy)
 project by [hwelch-fle](https://github.com/hwelch-fle) that primarily focuses on
 making the project a pip installable package.
 
-[Docs](https://hwelch-fle.github.io/plankapy/plankapy.html)
+[Original Docs](https://hwelch-fle.github.io/plankapy/plankapy.html)
 
-# Rest API Source
+## Installation
+
+```bash
+pip install git+https://git.private.coffee/PrivateCoffee/plankapy.git
+```
+
+## Usage
+
+```python
+from plankapy import Planka, User
+
+planka = Planka('http://localhost:3000', 'username', 'password')
+users = User(planka)
+
+for user in users.get():
+    print(user)
+```
+
+Refer to the [original docs](https://hwelch-fle.github.io/plankapy/plankapy.html)
+for more information.
+
+## Rest API Source
+
+### Routes
 
-## Routes
 https://github.com/plankanban/planka/blob/master/server/config/routes.js
 
-## Models
+### Models
+
 https://github.com/plankanban/planka/tree/master/server/api/models
 
-## Helpers
+### Helpers
+
 https://github.com/plankanban/planka/tree/master/server/api/helpers
diff --git a/pyproject.toml b/pyproject.toml
index 46bf409..9c29809 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -12,7 +12,7 @@ authors = [
 description = "A python 3 based API for controlling a self-hosted Planka instance"
 readme = "README.md"
 license = { file="LICENSE" }
-requires-python = ">=3.10"
+requires-python = ">=3.8"
 classifiers = [
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: GNU Affero General Public License v3",