Skip to content

Commit a19f55a

Browse files
committed
Minor changes to the documentation
1 parent 6f3612d commit a19f55a

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ for developers who want something that 'just works'.
2121

2222
We support getting information on all games,
2323
addons, categories, files, and so much more!
24-
We also offer easy to use methods for downloading
25-
files.
24+
We also offer easy to use methods for downloading files.
2625

2726
# Example
2827

@@ -33,7 +32,7 @@ GAME_ID = 432 # ID of the game you want to fetch, in this case Minecraft
3332

3433
# Create the CurseClient:
3534

36-
curse = CurseClient()
35+
curse = CurseClient(API_KEY)
3736

3837
# Get the game info:
3938

@@ -58,15 +57,16 @@ from cursepy import CurseClient
5857

5958
# Create the client:
6059

61-
client = CurseClient()
60+
client = CurseClient(API_KEY)
6261

6362
# Get a tuple of all games:
6463

6564
games = client.games()
6665
```
6766

6867
The CurseClient offers simple to use navigational methods for obtaining necessary information from CurseForge.
69-
CurseClient also allows for callbacks to be bound to events,
68+
Because CurseClient utilizes the official CurseForge API, we require an [API key](https://docs.curseforge.com/#what-is-curseforge-core) to use.
69+
CurseClient also allows for callbacks to be bound to events,
7070
meaning when an event is fired,
7171
your custom callback will also be cued.
7272
Here is an example of this in action:
@@ -122,7 +122,7 @@ mixed around, allowing for automated and easier customization
122122
compared to sub-classing.
123123

124124
cursepy has extensive documentation on handler development,
125-
which contains best practice recommendations. Docs on the cusepy Handler Framework(CHF)/tutorials on how to use the development handlers are already built into cursepy.
125+
which contains best practice recommendations. Docs on the cursepy Handler Framework(CHF)/tutorials on how to use the development handlers are already built into cursepy.
126126
Have a look at the [Handler Development Tutorial](https://cursepy.readthedocs.io/en/latest/advn/hand.html)!
127127

128128
## Curse Instances
@@ -161,10 +161,12 @@ Have a look at the [Wrapper Tutorial](https://cursepy.readthedocs.io/en/latest/b
161161

162162
You can install cursepy via pip:
163163

164-
$ pip install cursepy
164+
```bash
165+
pip install cursepy
166+
```
165167

166168
For more information on installing cursepy,
167-
check out the installation section in our [documentation](https://cursepy.readthedocs.io/en/latest/install.html).
169+
check out the installation section in our [documentation](https://cursepy.readthedocs.io/en/latest/install.html).
168170

169171
# Documentation
170172

@@ -181,14 +183,14 @@ The documentation is built using [sphinx](https://www.sphinx-doc.org/en/master/i
181183
Building the docs yourself is very simple.
182184
You can start by installing sphinx:
183185

184-
```
186+
```bash
185187
pip install sphinx
186188
```
187189

188190
Now, navigate to the 'docs' directory in your favorite terminal.
189191
Next, you can issue the 'make' command to build the docs:
190192

191-
```
193+
```bash
192194
make html
193195
```
194196

@@ -220,4 +222,4 @@ Sally Miller - Proof reading
220222

221223
cursepy offers a pythonic, intuitive way to interact with CurseForge projects!
222224
We offer high levels of customizability
223-
while at the same time being easy to use.
225+
while at the same time being easy to use.

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Here is an example of cursepy in action:
1313
1414
# Create the CurseClient:
1515
16-
curse = CurseClient()
16+
curse = CurseClient(API_KEY)
1717
1818
ADDON_ID = 1234
1919
@@ -25,7 +25,7 @@ Here is an example of cursepy in action:
2525
2626
print(addon.name)
2727
28-
This documentation houses the API reference, tutorials, and best practice recommendations.
28+
This documentation houses the API reference, tutorials, and best practice recommendations.
2929

3030
To get started, you should head over to the install page,
3131
where we go over how to install cursepy onto your machine.

0 commit comments

Comments
 (0)