From 3e59136c778961b677ad12f30bf6eb49ce6491e8 Mon Sep 17 00:00:00 2001
From: Josh Creek <jcreek93@gmail.com>
Date: Wed, 10 Apr 2019 22:35:47 +0100
Subject: [PATCH] Set a basic readme outlining the purposes of this project

---
 bank-statement-analyser/README.md | 42 +++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 bank-statement-analyser/README.md

diff --git a/bank-statement-analyser/README.md b/bank-statement-analyser/README.md
new file mode 100644
index 0000000..3b4b71f
--- /dev/null
+++ b/bank-statement-analyser/README.md
@@ -0,0 +1,42 @@
+# bank-statement-analyser
+
+## Project setup
+```
+npm install
+```
+
+### Compiles and hot-reloads for development
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+```
+npm run build
+```
+
+### Run your tests
+```
+npm run test
+```
+
+### Lints and fixes files
+```
+npm run lint
+```
+
+### Customize configuration
+See [Configuration Reference](https://cli.vuejs.org/config/).
+
+
+
+This project is designed to: 
+
+- Import a csv file (bank statement), ignoring any entries that already exist upon import 
+- Apply tags/categories to each transaction 
+- Be able to set rules to auto apply these, or manually set them for each item on a statement when adding it in
+- Have separate categories for savings and expenditure 
+- Be able to summarise (with graphs) expenditure and savings for any selected time period 
+- Be able to expand the above summaries for more detailed information 
+- Be able to calculate your current FIRE status (i.e. how much you save in a year, and, assuming a return of x%, how much your yearly income from investing your savings would be, compounding to calculate how long until you hit a minimum retirement goal - vaguely similar to https://app.fin-dee.com/)
+- Be able to analyse and capture trends in expenditure and saving across months/years
\ No newline at end of file