Skip to content

Commit 2146e86

Browse files
committed
doc: update README.md
1 parent ef17c27 commit 2146e86

File tree

1 file changed

+42
-30
lines changed

1 file changed

+42
-30
lines changed

Diff for: README.md

+42-30
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
11
# Ynabber
22

3-
Ynabber sets out to read and write bank transactions from one or more sources
4-
(known as readers) to one or more destinations (known as writers).
3+
Ynabber is a tool that reads and writes bank transactions from one or more
4+
sources (called readers) to one or more destinations (called writers). This
5+
makes it easier to pull in your bank transactions automatically and push them to
6+
personal finance apps like YNAB.
57

6-
For a list of supported see the [readers](#readers) and [writers](#writers)
7-
subsections.
8+
See subsection [readers](#readers) and [writers](#writers) for a list of
9+
supported banks and services.
810

911
## Installation
1012

11-
Install [Go](https://go.dev/) and run `go install` to install binary
13+
You can use [Go](https://go.dev/) or
14+
[Docker](https://www.docker.com/get-started/) to install and run Ynabber. Choose
15+
whichever option you find more convenient.
1216

1317
```bash
18+
# Install with Go
1419
go install github.com/martinohansen/ynabber/cmd/ynabber@latest
20+
21+
# Install with Docker
22+
docker pull ghcr.io/martinohansen/ynabber:latest
1523
```
1624

1725
## Usage
1826

19-
Ynabber is configured with environment variables. To read from
20-
[Nordigen](https://nordigen.com/en/) (now known as GoCardless) and write to YNAB
21-
use these values:
27+
Ynabber is configured via environment variables. Below is an example setup for
28+
reading transactions from
29+
[GoCardless](https://gocardless.com/bank-account-data/) (formerly known as
30+
Nordigen) and writing them to YNAB.
2231

2332
```bash
2433
cat <<EOT >> ynabber.env
@@ -34,19 +43,17 @@ NORDIGEN_SECRET_KEY=<nordigen secret key>
3443
EOT
3544
```
3645

37-
_All valid config options can be found [here](https://pkg.go.dev/github.com/martinohansen/ynabber#Config)_
38-
39-
Once the environment variables are set, run the binary:
46+
Then run Ynabber:
4047

4148
```bash
42-
# Read environment variables from file first
49+
# Load environment variables from the file
4350
set -a; . ./ynabber.env; set +a; ynabber
51+
52+
# Then run
4453
ynabber
4554
```
4655

47-
Or run in a container with
48-
[Docker](https://docs.docker.com/engine/reference/run/):
49-
56+
Or using Docker:
5057

5158
```bash
5259
docker run \
@@ -56,32 +63,37 @@ docker run \
5663
ghcr.io/martinohansen/ynabber:latest
5764
```
5865

66+
_All valid config variables can be found [here](https://pkg.go.dev/github.com/martinohansen/ynabber#Config)_
67+
5968
## Readers
6069

61-
Currently tested readers and verified banks, but any bank supported by Nordigen
62-
should work.
70+
Readers are how Ynabber fetches your transactions from the bank. Below are some
71+
tested examples. Generally, any bank supported by
72+
[GoCardless](https://gocardless.com/bank-account-data/) (formerly known as
73+
Nordigen) should work:
6374

64-
| Reader | Bank | |
65-
|----------|-----------------|---|
66-
| [Nordigen](/reader/nordigen/)[^1] | ALANDSBANKEN_AABAFI22 | ✅
67-
| | NORDEA_NDEADKKK | ✅
68-
| | NORDEA_NDEAFIHH | ✅
69-
| | NORWEGIAN_FI_NORWNOK1 | ✅
70-
| | S_PANKKI_SBANFIHH | ✅
75+
| Reader | Bank | Verified? |
76+
|:-------|:-----|:---------:|
77+
| [Nordigen](/reader/nordigen/)[^1] | ALANDSBANKEN_AABAFI22 | |
78+
| | NORDEA_NDEADKKK | |
79+
| | NORDEA_NDEAFIHH | |
80+
| | NORWEGIAN_FI_NORWNOK1 | |
81+
| | S_PANKKI_SBANFIHH | |
7182

7283
[^1]: Please open an [issue](https://github.com/martinohansen/ynabber/issues/new) if
7384
you have problems with a specific bank.
7485

7586
## Writers
7687

77-
The default writer is YNAB (that's really what this tool is set out to handle)
78-
but we also have a JSON writer that can be used for testing purposes.
88+
Writers tell Ynabber where to send the fetched transactions.
7989

8090
| Writer | Description |
81-
|---------|---------------|
82-
| [YNAB](/writer/ynab/) | Pushes transactions to YNAB |
83-
| [JSON](/writer/json/) | Writes transactions to stdout in JSON format |
91+
|:--------|:--------------|
92+
| [YNAB](/writer/ynab/) | Pushes transactions to a YNAB budget |
93+
| [JSON](/writer/json/) | Writes transactions as JSON to stdout (useful for testing) |
8494

8595
## Contributing
8696

87-
Pull requests are welcome.
97+
Pull requests are welcome! If you encounter a bug or have an idea for
98+
improvement, feel free to [open an issue](https://github.com/martinohansen/ynabber/issues/new).
99+
We’d love your help in making Ynabber better for everyone!

0 commit comments

Comments
 (0)