diff --git a/README.md b/README.md index e9d0136..744def3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ # Budgeteer -Budgeting Web-Application +Budgeting Web-Application written in Go and inspired by [YNAB](https://youneedabudget.com). -## Data structure +## Getting started -1 User -N Budgets - AccountID[] - CategoryID[] - PayeeID[] +The fastest way to get up and running quickly, is using docker-compose. Just download the [docker-compose.yml](https://git.javil.eu/jacob1123/budgeteer/src/branch/master/docker/docker-compose.yml) to some empty directory and run `docker-compose up -d`. This starts budgeteer, a postgres database and an adminer instance. The latter is optional and can be removed from the docker-compose.yml. -N Accounts - TransactionID[] -N Categories - AssignmentID[] -N Payees +## Known issues -N Transactions -N Assignments \ No newline at end of file +Currently the application is usable when importing from YNAB via their CSV export. All balances should match the balances from YNAB. There are even unit-tests that confirm that using my personal budget. + +For people wishing to start fresh in Budgeteer, there currently are some blockers though: +- The ability to create new accounts and categories is missing (#59) + +## Contributing + +If you're willing to help, please check the issues for [help-wanted labels](https://git.javil.eu/jacob1123/budgeteer/issues?labels=4). Just using Budgeteer and reporting any issues is although very helpful. \ No newline at end of file