From f3300e7e0dcf3bf6a53c483d7f34979fb606c77a Mon Sep 17 00:00:00 2001
From: Tobias Klug <tbs.klg@gmail.com>
Date: Sat, 17 Aug 2024 10:10:36 +0200
Subject: [PATCH] Provide readme

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index a09130b..311779f 100644
--- a/README.md
+++ b/README.md
@@ -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
+```
+