Skip to content

Commit

Permalink
Updated README with installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronTraas authored Dec 28, 2018
1 parent 48c16b5 commit c59d125
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ Clash Royale Clan Tools

This is a tool for creating a dashboard for clan participation in ClashRoyale. See https://developer.clashroyale.com to sign up for a developer account and create an API key to use with this.

==================================================
Installation
==================================================

This requires Python 3 and setup tools installed on your machine. See https://packaging.python.org/tutorials/installing-packages/ for details.

Once setuptools is installed, run the following in your shell:

.. code::
python3 setup.py install
==================================================
Syntax
==================================================
Expand Down Expand Up @@ -31,3 +43,31 @@ crtools looks for a config file in your home directory called .crtools

This is an INI file. As of current version, there's only one possible parameter: api_key. The file should look like:

.. code:: ini
[API]
api_key=<YOUR-API-KEY>
==================================================
Suggested usage on a Linux web server
==================================================

Assuming root is going to be running the script:

1. Download and install this application
2. Install nginx or apache
3. Create :code:`/root/.crtools` file as specified above, and add your API key
4. Find your document root (e.g., :code:`/var/www/html`)
5. Create the following entry in your crontab:

.. code::
0 * * * * root crtools --out=[YOUR-DOC-ROOT] [YOUR-CLAN-TAG]
For example:

.. code::
0 * * * * root crtools --out=/var/www/html \#JY8YVV
Note the '\' character before the # -- that's important. A '#' is a comment in most shells/scripting languages. You need to escape it to run it.

0 comments on commit c59d125

Please sign in to comment.