This commit is contained in:
parent
2f6818aa5d
commit
0800fa8cca
2 changed files with 13 additions and 2 deletions
15
README.md
15
README.md
|
@ -11,14 +11,25 @@ cd BunyMuny
|
||||||
dotnet build
|
dotnet build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Supported banks
|
||||||
|
- ME Bank ([guide](https://git.bune.city/lynnesbian/BunyMuny/raw/branch/master/guide/me.png))
|
||||||
|
- NAB
|
||||||
|
|
||||||
## The rules file
|
## 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
|
```csv
|
||||||
Match,Value,Category,Description,CaseSensitive
|
Match,Value,Category,Description,CaseSensitive
|
||||||
Start,Purchase Cash Converters,Personal,Cashies,true
|
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:
|
- `Match` specifies the type of matching to perform. It can be any of the following:
|
||||||
- "Start": Match the start of the description.
|
- "Start": Match the start of the description.
|
||||||
- "End": Match the end of the description.
|
- "End": Match the end of the description.
|
||||||
|
|
BIN
guide/me.png
Normal file
BIN
guide/me.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 89 KiB |
Loading…
Reference in a new issue