Skip to content

Commit

Permalink
Provide readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tbsklg committed Aug 17, 2024
1 parent cfd8bf8 commit f3300e7
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
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
```

0 comments on commit f3300e7

Please sign in to comment.