-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,25 @@ | ||
# Strikes | ||
|
||
## Usage | ||
- Add a strike to a user | ||
```bash | ||
strikes strike <user> | ||
``` | ||
|
||
- List all strikes | ||
```bash | ||
strikes ls | ||
``` | ||
|
||
## Use locally only | ||
You can use the local client without further configuration. | ||
It will generate a JSON file where the strikes are stored. | ||
The default path is in your home directory at '.strikes/db.json'. | ||
You can configure a different location by using the '--db_path' argument. | ||
|
||
The following command will create a database (db.json) in the current directory. | ||
|
||
```bash | ||
strikes --db_path . strike guenther | ||
``` | ||
|