Skip to content

Commit

Permalink
🎉 release(0.2.2): update README
Browse files Browse the repository at this point in the history
SerinaNya committed Jan 19, 2024
1 parent 017ec92 commit 2703a20
Showing 2 changed files with 29 additions and 5 deletions.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
<div align="center">

# 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 获取玩家的信息和材质。
</div>
<p align="center">
<img src="https://img.shields.io/github/stars/SerinaNya/yggdrasil-mc?style=social" alt="GitHub Repo stars">
<img src="https://img.shields.io/pypi/v/yggdrasil-mc?style=flat-square" alt="PyPI">
<img src="https://img.shields.io/pypi/pyversions/yggdrasil-mc?style=flat-square" alt="PyPI - Python Version">
<img src="https://img.shields.io/github/last-commit/SerinaNya/yggdrasil-mc/main?style=flat-square" alt="GitHub last commit (branch)">
<img src="https://img.shields.io/github/license/SerinaNya/yggdrasil-mc?style=flat-square" alt="GitHub">
</p>

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")
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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>"]

0 comments on commit 2703a20

Please sign in to comment.