From 1f73be785f5e4312a3565b926df84e16857525b4 Mon Sep 17 00:00:00 2001 From: Hugo Cachitas Date: Sat, 30 Mar 2024 23:56:57 +0000 Subject: [PATCH] Update README --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e40d41..b729019 100644 --- 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) + +```