Update README

cachitas · Mar 30, 2024 · 1f73be7 · 1f73be7
1 parent 945968d
commit 1f73be7
Showing 1 changed file with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
-# stringdb
-https://string-db.org
+# STRINGX
+
+STRINGX is a [STRING](string-db.org) API client using [HTTPX](https://www.python-httpx.org)
+
+## Install
+
+```sh
+pip install stringx
+```
+
+## Usage
+
+```python
+import stringx
+
+with stringx.Client() as client:
+    identifiers = client.map_identifiers(["edin", "atta"], species=7227)
+
+```