aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98044e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# 🐍 `sen-py`
+
+[![PyPI version](https://badge.fury.io/py/senpy-club.svg)](https://badge.fury.io/py/senpy-club)
+
+The Senpy Club API Wrapper for Python
+
+## Usage
+
+```shell
+poetry add senpy-club # Poetry
+pip install senpy-club # PIP
+```
+
+## Examples
+
+Examples can be found within the [`examples/`](./examples) directory.
+
+## License
+
+[GNU General Public License v3.0](https://github.com/senpy-club/sen-py/blob/main/LICENSE)