From f6dbf20b284e5c6ead9b8ff5047db6d6b2dd7d2d Mon Sep 17 00:00:00 2001
From: Mendel E <mendelmaleh@gmail.com>
Date: Wed, 4 May 2022 20:55:04 -0400
Subject: [PATCH] Add initial readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fee54e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# pfin: personal finance tools
+
+Collection of tools for parsing bank statements and csvs.
+
+[![Go Documentation](https://godocs.io/git.sr.ht/~mendelmaleh/pfin?status.svg)](https://godocs.io/git.sr.ht/~mendelmaleh/pfin)
+
+# structure
+
+- `pfin`: base library, defines transaction and parser interfaces, parser loading utility like database/sql
+- `pfin/util`: Utils for directory parsing, filter flags, and formatting functions
+- `pfin/parser`: parser implementations
+- `pfin/parser/util`: common code for parsers
+- `pfin/parser/all`: metapackage to load all parser implementations
+
+- `cmd/main`: prints out all transactions, can filter by account/user and sums by user
+- `cmd/unpaid`: get a list of unpaid transactions for a user
+- `cmd/status`: wip, get an overview of the statements tree
-- 
2.34.2