diff --git a/README.md b/README.md index 9ef1b2a..48a3d1c 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,25 @@ cd BunyMuny dotnet build ``` +## Supported banks +- ME Bank ([guide](https://git.bune.city/lynnesbian/BunyMuny/raw/branch/master/guide/me.png)) +- NAB + ## The rules file -By default, BunyMuny checks for rules in `rules.json` in the current directory. An example rules file might look like this: +By default, BunyMuny checks for rules in `rules.csv` in the current directory. +This is a Comma Separated Values file, which can be edited either by hand, or with a program like [Libreoffice Calc](https://www.libreoffice.org/discover/calc/) or [Microsoft Office Excel](https://www.microsoft.com/en-au/microsoft-365/excel). +An example rules file might look like this: ```csv Match,Value,Category,Description,CaseSensitive Start,Purchase Cash Converters,Personal,Cashies,true +Exact,Purchase TRANSLINK BRISBANE,Transport,Go Card,true ``` -This means that any statement that starts with "Purchase Cash Converters" (case sensitive) will be assigned the category "Personal", and the description "Cashies". +This means that: + - Any statement that starts with "Purchase Cash Converters" (case sensitive) will be assigned the category "Personal", and the description "Cashies". + - Any statement with the *exact* description "Purchase TRANSLINK BRISBANE" (case sensitive) will be assigned the category "Transport", and the description "Go Card". + - Any statement that doesn't match these two rules will be categorised as "Other", and will use the description provided by the bank file. +### Detailed explanation - `Match` specifies the type of matching to perform. It can be any of the following: - "Start": Match the start of the description. - "End": Match the end of the description. diff --git a/guide/me.png b/guide/me.png new file mode 100644 index 0000000..6336b54 Binary files /dev/null and b/guide/me.png differ