Compare commits
1 Commits
v1.0
...
2fd314b972
| Author | SHA1 | Date | |
|---|---|---|---|
| 2fd314b972 |
24
README.md
24
README.md
@@ -49,29 +49,33 @@ Goals of the project, ordered from easiest to hardest:
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Download from http://example.com/FIXME.
|
Download release from https://git.rcorral.es/ruben/riot-clojure/releases.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
FIXME: explanation
|
You can execute the app without params to get the help. Uberjar distribution needs
|
||||||
|
to be run with your java executable and the `-jar` parameter:
|
||||||
|
|
||||||
|
$ java -jar riot-clojure-1.0.0-standalone.jar [args]
|
||||||
|
|
||||||
|
Linux native imagen can be executed directly:
|
||||||
|
|
||||||
|
$ ./riot [args]
|
||||||
|
|
||||||
$ java -jar riot-clojure-0.1.0-standalone.jar [args]
|
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
FIXME: listing of options this app accepts.
|
There are a lot of paremeters. Execute the app without parameters to see all of them.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
...
|
The most tipycal usage is to show matches from some date (in ISO format):
|
||||||
|
|
||||||
### Bugs
|
$ ./riot <username> <tag> -s "2025-01-01"
|
||||||
|
|
||||||
...
|
If you wan't to export data as a CSV file
|
||||||
|
|
||||||
### Any Other Sections
|
$ ./riot <username> <tag> -s "2025-01-01" -o csv > matches.csv
|
||||||
### That You Think
|
|
||||||
### Might be Useful
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user