Adding a README describing the project

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a5521e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# cassiopeia
+
+A simple plaintext time-tracking tool.
+
+## How to use
+
+Cassiopeia works by associating account names with time-spans.
+The format for this is generally `account: <start> - <stop>`.
+A `<stop>` time can be omitted for open slots. Padding can be
+added as desired.
+
+`cass(1)` comes with a few commands
+
+- `--start=` will start tracking for an account
+- `--stop=` will stop tracking and error if no open slot exists
+
+You always need to provide a file to work on with `-f` or `--file`.
+Also optionally `-r` can be used to round to the nearest 15-minutes.
+Line comments are available with `#`.
+
+## State of the project
+
+The project is very alpha and there are many things that should
+be improved.
+
+- Better CLI handling (`optparse` is kinda bad)
+- Slot descriptors (to add details to what was worked on)
+- Automatically pad generated slots
+- Generate and export statistics
+
+Contrutions welcome via my [public inbox][1]
+
+[1]: https://lists.sr.ht/~spacekookie/public-inbox