Updated README to add changes and start instructions

Author: himmAllRight

README.md

@@ -1,40 +1,75 @@
 # LIA (Ledger Import Assistant)
-
 [![Build Status](https://travis-ci.org/himmAllRight/LIA.svg?branch=master)](https://travis-ci.org/himmAllRight/LIA/)
 
-LIA is a simple command-line python application that can help import exported Cedit Card and Bank statement csv files into a ledger journal. There are many other great convert/import options out there. However, I found their setup to often be a bit more complicated than what I needed initially, so I decided to write my own tool. Development of LIA will expand with my use of ledger.
+LIA is a simple command-line python application that can help import exported Cedit Card and Bank statement csv files into a ledger journal file. There are several other great ledger convert/import options out there, but many more complicated than what I was looking for. So...I decided to write my own tool. Thus, LIA.
 
 ### Features:
 - CSV files are read in and converted to simple ledger journal statements.
 - Data order is recognized by a header mechanism
-- Prompts the user to potentially edit the transaction data (defaults to csv value)
+- Prompts the user to potentially edit the transaction information (defaults to csv value)
+- Manual transaction entry (if desired)
 - Supports multiple destination accounts
+- Automatic placement system. The user can specify a file containing rules to automatically place transactions. (ex: anything with "Dunkin" in the description will default to _Expenses:Food:Coffee_)
+- Colored prompts
 
-- NOTE: I think the output file may be overwritten right now
+## Installation Instructions
+_To add_
 
-### Command Line Options
-| Flags | description |
-|-------|-------------|
-| -f, --import | input csv file to convert. If not provided just reads from cache |
-| -o, --output | Output ledger file name |
-| -r, --overwrite | Overwrites the output file. Appends by default |
-| -a, --import-account | The account the import data is from |
-| -d, --date-format | the date format for dates in the csv (ex: "%m/%d/%Y") |
-| -h | Help |
+## Run Instructions
+#### Setting up the Input File Header
+First, the input file needs to be setup so that LIA can properly understand the data order for parsing. To do this, just open up the .csv file and add a header. Many exported CSV files will already contain some sort of data header which can be used to write the LIA header.
+
+For example, when I export my credit card transactions to a CSV, it contains the header:
+
+`Trans. Date,Post Date,Description,Amount,Category`
+
+![Credit Card Download transaction csv](img/creditCardDownload.png)
+
+LIA by contrast, need headers for ``"description"``, `"date"`. and `"amount"`* (all in lowercase). So, using the current header contents for reference, I edited by adding in the three keywords mentioned above, and replaced any extrainous ones with blanks between the commas. For example:
+
+`date,,description,amount,`
+
+![Credit Card Download transaction csv](img/editedHeader.png)
 
+Note: I can have other values marked in the header for my convenience, but LIA will currently only recognize these three. It is intended to eventually have the others utilized in the automatic rules system. For example, in my test input file, I have the header set to the following, even though I do not use "posted" for anything.
 
-### Instructions
+`date,posted,description,amount,`
+
+\* *In the future there might be more options, but for now LIA only recognizes these three.*
+
+#### Starting LIA
+LIA is a python app, so currently the method to run it is by running `lia.py` with python. Python 2 and 3 should both be supported, but 3 is preferred. You will have to provide a few required arguments, and can also specify a few optional ones. All of the command line options are listed in the table below.
+
+example:
+`python3 lia.py -f credit-card.csv -o ledger.dat -a "Liabilities:CreditCard:Discover" -d "%m/%d/%Y" -c`
+
+### Command Line Options
+This table lists all of the command line options for LIA. The first column states the flag to use when calling the option. The second column provides a small description of the option, while the third column states if it is a required parameter. Lastly, the fourth column defines if you need to provide a value to the argument to the option (_ex: `-f` needs a file path after it, but you just need to write `-w` to use the overwrite option_).
+
+| Flags | Description | Required? | Provide Value?|
+|-------|-------------|-----------|---------------|
+| -f, --import | Input csv file to convert. If not provided just reads from cache | Yes | Yes |
+| -o, --output | Output ledger file name/path | Yes | Yes |
+| -w, --overwrite | Overwrites the output file. (Normally Appends by default) | No | No |
+| -a, --import-account | The account the import data is from | Yes | Yes |
+| -d, --date-format | The date format for dates in the input (ex: "%m/%d/%Y") | No | Yes |
+| -r, --rules | Specify a file that contains rules for automatic Account placements | No | Yes |
+| -c, --color | Switch on colors in prompt | No | No |
+| -h | Help | No | No |
 
-_To add later_
 
 ### Example
-`python3 lia.py -f credit-card.csv -o ledger.dat -a "Liabilities:CreditCard:Discover" -d "%m/%d/%Y"`
+`python3 lia.py -f credit-card.csv -o ledger.dat -a "Liabilities:CreditCard:Discover" -d "%m/%d/%Y" -c`
 
-### Future TODO Features
+### Remaining TODO for 1.0 Release
 - [X] Output appends, unless --overwrite flag
 - [X] When looping through an input file, it copies the input file to a temp and pops items off as it works through them. This way, if you stop part-way through, you can pick up where it was last left off.
 - [X] Users can simply input new transactions, without improting a csv.
-- [ ] User can setup rules/parsers to default transaction placement. (ex: anything from "cumberland farms" will default to Expenses:Transportation:Gas)
+- [X] User can setup rules/parsers to default transaction placement. (ex: anything from "cumberland farms" will default to Expenses:Transportation:Gas)
 - [X] When user edits data, default values are editable in the prompt
-- [ ] Option to have statements with reconciled indicator
-
+- [ ] Option to have statements with reconciled indicator (?)
+- [ ] Build simple install system
+- [ ] Update README file
+  - [ ] Update Current Readme content
+  - [ ] Write Install Instructions
+  - [ ] Write Use Instructions