Skip to content

Commit 8771405

Browse files
committed
word art :)
1 parent 71b1d2d commit 8771405

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

README.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
BrawlStats
2-
==========
1+
.. image:: https://i.imgur.com/5uUkTrn.png
2+
:alt: Brawl Stats
3+
4+
Brawl Stats
5+
===========
36

47
.. image:: https://img.shields.io/pypi/v/brawlstats.svg
58
:target: https://pypi.org/project/brawlstats/
@@ -13,13 +16,15 @@ BrawlStats
1316
:target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
1417
:alt: MIT License
1518

16-
This library is a sync and async wrapper `Brawl Stars API`_
19+
| This library is a sync and async wrapper the unofficial `Brawl Stars API`_.
20+
| Please note that both this API and wrapper are both still in beta, so there will be frequent breaking changes.
1721
1822
Features
1923
~~~~~~~~
2024

2125
- Covers the full API
2226
- Easy to use async or sync client
27+
- Helper functions for access to other game files
2328

2429
Installation
2530
~~~~~~~~~~~~

docs/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to BrawlStats' documentation!
2-
=====================================
1+
Welcome to Brawl Stats' documentation!
2+
======================================
33

44
.. image:: https://img.shields.io/pypi/v/brawlstats.svg
55
:target: https://pypi.org/project/brawlstats/
@@ -13,13 +13,15 @@ Welcome to BrawlStats' documentation!
1313
:target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
1414
:alt: MIT License
1515

16-
BrawlStats is an easy to use async wrapper for the unofficial `Brawl Stars API`_
16+
| Brawl Stats is an easy to use async wrapper for the unofficial `Brawl Stars API`_.
17+
| Please note that both this API and wrapper are both still in beta, so there will be frequent breaking changes.
1718
1819
Features
1920
~~~~~~~~
2021

2122
- Covers the full API
2223
- Easy to use async or sync client
24+
- Helper functions to access other game files
2325

2426
Installation
2527
~~~~~~~~~~~~

0 commit comments

Comments
 (0)