aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: e3100a50e2fe63fa81798127b1cd0b1ef815e3b5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
📘 Nitrous
==========

What?
-----

Nitrous is a Discord Nitro code generator and checker.

Why should I use Nitrous?
-------------------------
- Nitrous is very fast.
- Nitrous is simple to use.
- Nitrous is efficient.

Getting up and Running
----------------------

Building
^^^^^^^^

.. code-block:: shell

  $ cargo build --release

Running
^^^^^^^

Generating Codes
""""""""""""""""

.. code-block:: shell

  $ nitrous generate <amount>

The amount may be **any** number, your CPU is the only limit.

Checking Codes
""""""""""""""

.. code-block:: shell

  $ nitrous check

The previous command (without any specified codes file) will run the check
routine on a default file value of `./nitrous/codes.txt`. If you would like to
override this behaviour, specify your file after the subcommand;

.. code-block:: shell

  $ nitrous check /path/to/codes.txt

Up and Comming
--------------

- Proxy support

License
-------

`GNU General Public License v3.0 <./LICENSE>`_