Selaa lähdekoodia

More documentation

Nikola Kotur 3 vuotta sitten
vanhempi
commit
18bc90ff8a
1 muutettua tiedostoa jossa 23 lisäystä ja 2 poistoa
  1. 23 2
      README.md

+ 23 - 2
README.md

@@ -2,9 +2,30 @@
 
 Weekly spending reports from YNAB to Rocket.chat.
 
-## Docker development
+## Preparation
+
+## Installation
+
+YNRC is simple and complete Python package, so if you know how to handle Python packages you can use it right away. For example, to install it in your virutal environment you would:
+
+```
+python3 -m pip install git+ssh://git@git.kotur.org:8022/kotnik/ynrc.git
+```
+
+Branch `master` is guaranteed to be runnable at all times.
+
+On the other hand, if you are not experienced with Python you can use Docker. Clone repository and build the container with:
 
 ```
 docker build -t ynrc .
-docker run -it --rm ynrc
 ```
+
+Afterwards you can run YNRC (or add it to your crontab) as simple as:
+
+```
+docker run -it --rm ynrc weekly_report --ynab-api-key <add the rest of command line options, see --help>
+```
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.