Skip to content

Commit

Permalink
Update README.org
Browse files Browse the repository at this point in the history
  • Loading branch information
axeoman committed Aug 13, 2023
1 parent a1efa52 commit 11dd8f3
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ docker build -t ynab-sync .
docker run --env-file=sandbox.env --rm ynab-sync
#+end_src

** Getting budget and account ids
There are three commands that can help you with getting nessesary identifiers (probably buggy, but still)
- ~gocardless banks~ - list of banks that needed for next step (auth)
- ~gocardless generate_bank_auth_link~ - creates http link in order to auth with your bank
- ~gocardless list_requisition_account~ - get GOCARDLESS_ACCOUNT_ID that is nessesary for ~upload~ command
- ~ynab budgets~ - lists budgets in your YNAB account (YNAB_BUDGET_ID)
- ~ynab accounts~ - lists accoutns in your YNAB budget (YNAB_ACCOUNT_ID)

* Development
I have an e2e happy path test: feel free to submit a PR :)

Expand All @@ -57,9 +65,11 @@ I have an e2e happy path test: feel free to submit a PR :)
** TODOs
- [X] MVP
- [X] end-to-end automated tests based on results of MVP
- [X] separate cli from logic
- [ ] refactor API classes
- [ ] separate cli from logic
- [ ] add usefull commands (building links, getting GoCardless and YNAB account/budget information)
- [X] add usefull commands (building links, getting GoCardless and YNAB account/budget information)
- [ ] add packaging
- [ ] add simple interactive command that provides you with .env file and all nessesary variables to get bank data

** Initial requirements
- Upload fresh bank transactions to YNAB
Expand Down

0 comments on commit 11dd8f3

Please sign in to comment.