aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0f729e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Chaos Billing
+
+A command-line bill splitting tool
+
+## Installation
+```bash
+cargo install --path .
+```
+
+## Usage
+```bash
+# Add a bill
+cobill add Alice --paid 20 --for Alice Bob --reason Food
+
+# List bills
+cobill ls
+
+# Optimize splits
+cobill ls --optimize
+
+# Edit
+cobill edit # or `cobill vi/vim/nvim/helix/nano`
+
+# Clear
+cobill clear
+```
+
+## License
+This project uses the [WTFPL](./LICENSE)