Skip to content

Commit 5e6e754

Browse files
committed
docs(README): Adding usage
1 parent 57ad1ec commit 5e6e754

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,16 @@ The initial idea is to have all the logging of the `IRC` channel dumped into a `
1717
1. Via commands on `IRC`
1818
2. Via a web site that the bot, itself, serves
1919

20-
Not sure if it's worth having the bot itself serve the website, but due to the fact that `SQLite` will be locked during the bot's operation, then this will have to be the path, for the time being.
20+
Not sure if it's worth having the bot itself serve the website, but due to the fact that `SQLite` will be locked during the bot's operation, then this will have to be the path, for the time being.
21+
22+
# Usage
23+
24+
```console
25+
$ paslogbot -h
26+
Usage:
27+
paslogbot [PARAMS]
28+
29+
PARAMS:
30+
-h/--help This help message.
31+
-c/--config=FILE Use provided FILE as config. ( default: ~/.pasirclogbot )
32+
```

0 commit comments

Comments
 (0)