Added readme

1 files changed, 25 insertions, 0 deletions

diff --git a/readme.org b/readme.org
new file mode 100644
index 0000000..9631145
--- /dev/null
+++ b/readme.org
@@ -0,0 +1,25 @@
+#+TITLE: Quick and Dirty QIF Preprocessing
+
+This small Rust program to preprocess QIF files that I get from my
+bank account. This mostly means normalizing the descriptions a bit,
+since my bank statement often does silly things like appending a
+timestamp to the end. Also, different stores in the same franchise
+sometimes use slightly different names. For example, I normalize "Kung
+fu kitchen" and "Kungfu kitchen" to have the same description.
+
+This is highly specialized for my own use, and isn't intended to be
+generally useful or configurable.
+
+* Usage
+
+#+BEGIN_EXAMPLE
+  USAGE:
+      qif_parser [files]...
+
+  FLAGS:
+      -h, --help       Prints help information
+      -V, --version    Prints version information
+
+  ARGS:
+      <files>...    Files to preprocess
+#+END_EXAMPLE