Skip to content

Commit

Permalink
feat: buff readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GetPsyched committed Dec 22, 2023
1 parent 18d10dd commit 1605662
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

0 comments on commit 1605662

Please sign in to comment.