Skip to content

Commit 8faa6f1

Browse files
committed
Update readme
1 parent 3e04852 commit 8faa6f1

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,21 @@ strikes ls
1515
You can use the local client without a remote server.
1616
It will generate a JSON file where the strikes are stored.
1717
The default path is in your home directory at '.strikes/db.json'.
18-
You can configure a different location by using the '--db_path' argument.
18+
You can configure a different location by using the '--db_path' argument or by providing a configuration file.
19+
The argument has precedence over the configuration file.
20+
21+
```bash
22+
23+
### Configuration file
24+
The configuration file needs to be a yaml file.
25+
26+
```yaml
27+
db_path: /path/to/db.json
28+
```
1929

2030
The following command will create a database (db.json) in the current directory.
2131

2232
```bash
23-
strikes --db_path . strike guenther
33+
strikes --db_path . strike <user>
2434
```
2535

0 commit comments

Comments
 (0)