From 917311a92666b0600a17e4142904dd4e99d943ef Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=B4=9B=E6=B0=B4=E5=B1=85=E5=AE=A4?=
 <luoshuijs@outlook.com>
Date: Mon, 1 May 2023 21:33:39 +0800
Subject: [PATCH] :memo: Add README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4062059
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Semi-Intransient Matrix Network
+
+Modern API wrapper for Genshin Impact & Honkai: Star Rail built on asyncio and pydantic.
+
+## Requirements
+
+- Python 3.9+
+- httpx
+- Pydantic
+
+## Example
+
+A very simple example of how simnet would be used:
+
+```python3
+import asyncio
+import simnet
+
+async def main():
+    cookies = {} # write your cookies
+    player_id = 123456789
+    async with simnet.StarRailClient(cookies, player_id=player_id) as client:
+        data = await client.get_starrail_user()
+        print(f"Player has a total of {data.stats.avatar_num} characters")
+
+asyncio.run(main())
+```
+
+## Credits
+- [genshin.py](https://github.com/thesadru/genshin.py/): fork source 
\ No newline at end of file