Add readme and license

This commit is contained in:
Illya Marchenko 2024-04-11 13:15:37 +03:00
parent 7057d0a459
commit e0fcc02fff
Signed by: stuzer05
GPG Key ID: A6ABAAA9268F9F4F
2 changed files with 37 additions and 0 deletions

7
LICENSE Normal file
View File

@ -0,0 +1,7 @@
Copyright 2024 Illya Marchenko
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# Monobank - Firefly3 bot
This bot is used to automatically log transactions from Monobank (via webhook) to [Firefly3](https://www.firefly-iii.org/).
Bot creates firefly3 transactions which are meant to be further processed by Firefly3 rules
## Installation
```sh
git clone https://gitea.stuzer.link/stuzer05/monobank-firefly3-bot.git
cd monobank-firefly3-bot
make
```
## Configuration
create `.env` file and `config.json`
```sh
cp .env.example .env
cp config.json.example config.json
```
set credential in `.env`
configure accounts in `config.json`
configure which transactions to match (by name or mcc codes) in `config.json`