chore: update readme [skip ci]

gabotechs · Jun 10, 2023 · fdb7e0d · fdb7e0d
1 parent 341b34d
commit fdb7e0d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,4 +3,23 @@
 Generate signed urls for [Signway](https://github.com/gabotechs/signway), so that they can be
 used in client-side code.
 
+# Install
 
+```shell
+pip install signway-sdk
+```
+
+# Usage
+
+```shell
+from signway_sdk import sign_url
+
+sign_url(
+    id="my-id",
+    secret="my-secret",
+    host="https://api.signway.io",
+    proxy_url="https://api.openai.com/v1/chat/completions",
+    expiry=10,
+    method="POST"
+)
+```