📝 Add README.md

This commit is contained in:
洛水居室 2023-05-01 21:33:39 +08:00
parent cd97a751b9
commit 917311a926
No known key found for this signature in database
GPG Key ID: C9DE87DA724B88FC

30
README.md Normal file
View File

@ -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