Skip to content

Commit 52b364a

Browse files
committed
change installing command
add pypi badges add comment to examples, explaining the port argument
1 parent c315674 commit 52b364a

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# aiomcrcon
2-
![Dynamic TOML Badge](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Farvitus%2Faiomcrcon%2Fmaster%2Fpyproject.toml&query=%24.project%5B%22requires-python%22%5D&style=for-the-badge&label=Python&color=blue)
2+
![Python Versions](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Farvitus%2Faiomcrcon%2Fmaster%2Fpyproject.toml&query=%24.project%5B%22requires-python%22%5D&style=for-the-badge&label=Python&color=blue)
33
![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/arvitus/aiomcrcon?style=for-the-badge&color=green)
4-
<!--
5-
[![PyPI - Version](https://img.shields.io/pypi/v/aiomcrcon?style=for-the-badge&color=green)](https://pypi.org/project/aiomcrcon)
6-
[![PyPI - Downloads](https://img.shields.io/pypi/dm/aiomcrcon?style=for-the-badge&color=green)](https://pypi.org/project/aiomcrcon)
7-
-->
8-
An async Minecraft RCON client library with support for fragmented responses.
4+
[![PyPI - Version](https://img.shields.io/pypi/v/py-aio-mcrcon?style=for-the-badge&color=green)](https://pypi.org/project/py-aio-mcrcon)
5+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/py-aio-mcrcon?style=for-the-badge&color=green)](https://pypi.org/project/py-aio-mcrcon)
96

7+
An async Minecraft RCON client library with support for fragmented responses.
108

119
## Installing
1210
```sh
13-
pip install git+https://github.com/arvitus/aiomcrcon
11+
pip install py-aio-mcrcon
1412
```
1513

1614
## Example
@@ -24,7 +22,7 @@ async def main():
2422
response = await client.command("list")
2523

2624
# Without context manager
27-
client = aiomcrcon.Client("myserver.com", "password")
25+
client = aiomcrcon.Client("myserver.com", "password") # port is optional, default is default RCON port
2826
await client.connect()
2927
response = await client.command("list")
3028
await client.close()

0 commit comments

Comments
 (0)