Skip to content

Commit 48aac77

Browse files
committed
Update README.rst to v1.0
1 parent e3ad2cf commit 48aac77

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,13 @@ Installing
3131
.. code:: sh
3232
3333
# Linux/macOS
34-
python3 -m pip install -U git+https://github.com/mathsman5133/coc.py@rewrite
34+
python3 -m pip install -U coc.py
3535
3636
# Windows
37-
py -3 -m pip install -U git+https://github.com/mathsman5133/coc.py@rewrite
37+
py -3 -m pip install -U coc.py
38+
39+
# to install the development version:
40+
python3 -m pip install -U git+https://github.com/mathsman5133/coc.py
3841
3942
4043
Quick Example
@@ -77,14 +80,14 @@ whenever someone joins the clan or a member of the clan donates troops.
7780
client = coc.login('email', 'password', client=coc.EventsClient)
7881
7982
@client.event
80-
@coc.ClanEvents.member_join("clan tag")
83+
@coc.ClanEvents.member_join(tags=["#clantag", "#clantag2"])
8184
async def foo(player, clan):
8285
print("{0.name} ({0.tag}) just joined {1.name} ({1.tag})!".format(player, clan))
8386
8487
@client.event
85-
@coc.ClanEvents.member_donations("clan tag")
88+
@coc.ClanEvents.member_donations(tags=["#clantag", "#clantag2"])
8689
async def bar(old_member, member):
87-
troops_donated = old_member.donations - member.donations
90+
troops_donated = member.donations - old_member.donations
8891
print("{0} just donated {1} troops!".format(member.name, troops_donated))
8992
9093
client.run_forever()
@@ -96,13 +99,12 @@ Contributing
9699
--------------
97100
Contributing is fantastic and much welcomed! If you have an issue, feel free to open an issue and start working on it.
98101

99-
If you wish to run, setup or work on documentation, you will need to install `sphinx` and `sphinx-rtd-theme`.
102+
If you wish to run, setup or work on documentation, you will need to install ``sphinx`` and a few related dependencies.
100103
These can be installed with:
101104

102105
.. code:: sh
103106
104-
pip install sphinx
105-
pip install sphinx-rtd-theme
107+
pip install .[docs]
106108
107109
If you wish to run linting, pylint, black and flake8 have been setup and can be run with:
108110

0 commit comments

Comments
 (0)