diff --git a/README.md b/README.md index 4816a46..a27eea0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,35 @@ +
+ # yggdrasil-mc -![GitHub Repo stars](https://img.shields.io/github/stars/SerinaNya/yggdrasil-mc?style=social) ![PyPI](https://img.shields.io/pypi/v/yggdrasil-mc?style=flat-square) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/yggdrasil-mc?style=flat-square) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/SerinaNya/yggdrasil-mc/main?style=flat-square) ![GitHub](https://img.shields.io/github/license/SerinaNya/yggdrasil-mc?style=flat-square) +_A simple Python lib to get player info and texture from Mojang and Yggdrasil APIs._ + +> 一个简单的 Python 库，可从 Mojang 和 Yggdrasil APIs 获取玩家的信息和材质。 +
+ +

+GitHub Repo stars +PyPI +PyPI - Python Version +GitHub last commit (branch) +GitHub +

-A simple Python lib to get player info and texture from Mojang and Yggdrasil APIs. -一个简单的 Python 库，可从 Mojang 和 Yggdrasil APIs 获取玩家的信息和材质。 ## Attention -This package can run in **Python 3.10+ ONLY**. +This package can be used with **Python 3.10+ ONLY**. + +## Usage + +``` shell +pip3 install yggdrasil-mc +``` + +``` python +from yggdrasil_mc.client import YggdrasilMC + +ygg = YggdrasilMC() +await ygg.by_name_async("SerinaNya") +``` diff --git a/pyproject.toml b/pyproject.toml index 36da8b7..af76719 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "yggdrasil-mc" -version = "0.2.1" +version = "0.2.2" description = "A simple Python lib to get player info and texture from Mojang and Yggdrasil APIs. / 一个简单的 Python 库，可从 Mojang 和 Yggdrasil APIs 获取玩家的信息和材质。" license = "AGPL-3.0-or-later" authors = ["SerinaNya <34389622+SerinaNya@users.noreply.github.com>"]