aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-03-23 01:01:33 -0700
committerFuwn <[email protected]>2022-03-23 01:01:33 -0700
commit4462f6f8cd4d307f4ae180ed0a180628f3ba762f (patch)
treefc7b80f76de66967a9f2365debf9a644dea98cf5 /README.rst
downloadsen-py-4462f6f8cd4d307f4ae180ed0a180628f3ba762f.tar.xz
sen-py-4462f6f8cd4d307f4ae180ed0a180628f3ba762f.zip
feat: 0.1.0 :star:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..6110c7b
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,24 @@
+🐍 :code:`sen-py`
+================
+
+The Senpy Club API Wrapper for Python
+
+Usage
+-----
+
+.. code-block:: shell
+
+ poetry add sen-py # Poetry
+ pip install sen-py # PIP
+
+Examples
+--------
+
+.. raw:: html
+
+ Examples can be found within the <a href="./examples"><code>examples/</code></a> directory.
+
+License
+-------
+
+`GNU General Public License v3.0 <https://github.com/senpy-club/sen-py/blob/main/LICENSE>`_