Skip to content

Commit

Permalink
Minor changes to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
OwenCochell committed Aug 19, 2022
1 parent 6f3612d commit a19f55a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ for developers who want something that 'just works'.

We support getting information on all games,
addons, categories, files, and so much more!
We also offer easy to use methods for downloading
files.
We also offer easy to use methods for downloading files.

# Example

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

# Create the CurseClient:

curse = CurseClient()
curse = CurseClient(API_KEY)

# Get the game info:

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

# Create the client:

client = CurseClient()
client = CurseClient(API_KEY)

# Get a tuple of all games:

games = client.games()
```

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

cursepy has extensive documentation on handler development,
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.
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.
Have a look at the [Handler Development Tutorial](https://cursepy.readthedocs.io/en/latest/advn/hand.html)!

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

You can install cursepy via pip:

$ pip install cursepy
```bash
pip install cursepy
```

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

# Documentation

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

```
```bash
pip install sphinx
```

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

```
```bash
make html
```

Expand Down Expand Up @@ -220,4 +222,4 @@ Sally Miller - Proof reading

cursepy offers a pythonic, intuitive way to interact with CurseForge projects!
We offer high levels of customizability
while at the same time being easy to use.
while at the same time being easy to use.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here is an example of cursepy in action:
# Create the CurseClient:
curse = CurseClient()
curse = CurseClient(API_KEY)
ADDON_ID = 1234
Expand All @@ -25,7 +25,7 @@ Here is an example of cursepy in action:
print(addon.name)
This documentation houses the API reference, tutorials, and best practice recommendations.
This documentation houses the API reference, tutorials, and best practice recommendations.

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

0 comments on commit a19f55a

Please sign in to comment.