aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--LICENSE13
-rw-r--r--README.md29
2 files changed, 42 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..5c93f45
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+ Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
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)