Updated README
This commit is contained in:
parent
12d7f54557
commit
4b5eca291b
1 changed files with 11 additions and 0 deletions
11
README.rst
11
README.rst
|
@ -2,11 +2,22 @@
|
|||
The Accounting API
|
||||
====================
|
||||
|
||||
--------------
|
||||
Dependencies
|
||||
--------------
|
||||
|
||||
- ledger-cli version 3 (I have not tried with version 2.x)
|
||||
- Flask (install by running ``pip install -r requirements.txt``).
|
||||
|
||||
|
||||
-------
|
||||
Usage
|
||||
-------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Run the web service
|
||||
LEDGER_FILE=../path/to/your.ledger ./bin/serve
|
||||
|
||||
# Run a simple example
|
||||
python3 accounting/__init__.py
|
||||
|
|
Loading…
Reference in a new issue