feat: buff readme

charachorder/__init__.py

@@ -13,7 +13,7 @@
 __author__ = "GetPsyched"
 __license__ = "MIT"
 __copyright__ = "Copyright 2023-present GetPsyched"
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 from .device import *
 from .errors import *

readme.md

@@ -2,9 +2,34 @@
 
 A wrapper for CharaChorder's Serial API written in Python
 
-> **Warning**
+> **Warning:**
 > This project is in beta; breaking changes will occur without notice. Please wait for v1.0.0
 
+## Features
+
+- Supports all major versions of Python3.
+- Exhaustive list of commands as in the [Serial API](https://docs.charachorder.com/SerialAPI.html).
+- Events (coming soon).
+
+## Installation
+
+**Python 3.8 or higher is required.**
+
+```sh
+# Linux/macOS
+python3 -m pip install -U discord.py
+
+# Windows
+py -3 -m pip install -U discord.py
+```
+
+To install the development version, run the following:
+```sh
+git clone https://github.com/GetPsyched/charachorder.py
+cd charachorder.py
+python3 -m pip install -U .
+```
+
 ## Usage
 
 ```py
@@ -14,3 +39,9 @@ for device in CCDevice.list_devices():
     with CCSerial(device) as cc_serial:
         print(cc_serial.get_device_id())
 ```
+
+## Links
+
+- Documentation (TODO)
+- [CharaChorder's Official Discord Server](https://discord.gg/QZJeZGtznG)
+- [Serial API](https://docs.charachorder.com/SerialAPI.html)