From 789da58d3c372545393ae57c5b53869a2ab15d68 Mon Sep 17 00:00:00 2001
From: Lengyue <lengyue@lengyue.me>
Date: Sat, 24 Aug 2024 06:21:29 -0400
Subject: [PATCH] add license and readme

---
 LICENSE   |  7 +++++++
 README.md | 23 ++++++++++++++++++++---
 setup.py  |  1 +
 3 files changed, 28 insertions(+), 3 deletions(-)
 create mode 100644 LICENSE

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..32e20cd
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2024, Fish Audio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index 8085a4b..771c358 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,26 @@
-# opusenc
+# OPUSENC
 
-For any system <= Ubuntu 22.04, you need to install libopusenc-dev manually, run `install_opus.sh`
+## Requirements
+- libopus-dev
+- libopusfile-dev
+- libopusenc-dev
 
-For Ubuntu 24.04, you can install libopusenc-dev via apt:
+### Ubuntu ≤ 22.04
+```bash
+sudo apt install libopus-dev libopusfile-dev
+bash install_opus.sh # install libopusenc-dev
+```
+
+### Ubuntu 24.04
 
 ```bash
 sudo apt install libopus-dev libopusfile-dev libopusenc-dev
 ```
+
+## Installation
+```bash
+pip install git+https://github.com/fishaudio/opusenc.git
+```
+
+## Usage
+Check `tests/test.py` for more details.
diff --git a/setup.py b/setup.py
index 9752b24..149e5f3 100644
--- a/setup.py
+++ b/setup.py
@@ -33,4 +33,5 @@
     cmdclass={"build_ext": build_ext},
     zip_safe=False,
     python_requires=">=3.7",
+    license="MIT",
 )