Skip to content

Commit

Permalink
docs: tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
201st-Luka committed Sep 15, 2023
1 parent 8a15eb8 commit db22cf6
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/Tutorials/01_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,12 @@

## Requirements

To use the [PyClasher](../index.md)-package you need Python 3.8 or higher.
To use the [PyClasher](../index.md)-package you need Python 3.8 or higher.

## Installation

The package is accessible on [PyPi.org](pypi.org) so you can install the package
using
```bash
pip install pyclasher
```
18 changes: 18 additions & 0 deletions docs/Tutorials/11_setting_up_a_Client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Setting up a Client

The [Client][client_ref]
is the heard of this package. It allows to make the requests.

## The client

The [Client][client_ref] uses API tokens that you can obtain from the official
[ClashOfClans developer portal](https://developer.clashofclans.com/#/). Those
tokens serve as a verification to the ClashOfClans API. It is sufficient to
create an account and create one or multiple tokens.




<!---links--->
[client_ref]: ../API%20Reference/client/client.md#pyclasher.client.client.Client

7 changes: 7 additions & 0 deletions docs/Tutorials/12_Requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Requests

The requests defined in this package are a user-friendly implementation of
requesting and getting data of the official ClashOfClans-API. The requests
return models that are some kind of wrapper for the data that hides behind the
models. Those models have error handling and are easier to use than raw JSON
data.

0 comments on commit db22cf6

Please sign in to comment.