Skip to content

Commit

Permalink
fixup! docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martinohansen committed Dec 22, 2023
1 parent 75c9807 commit f63733b
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Ynabber

Ynabber reads and writes transactions from one or more places. For a list of
supported see [readers](#readers) and [writers](#writers).
Ynabber reads and writes transactions from one or more sources (known as
readers) to one or more destinations (known as writers). For a list of supported
see the [readers](#readers) and [writers](#writers) subsections.

## Installation

Expand All @@ -13,9 +14,9 @@ go install github.com/martinohansen/ynabber/cmd/ynabber@latest

## Usage

Ynabber is configured with environment variables, for example, reading from
[Nordigen](https://nordigen.com/en/) requires these. All valid config options
can be found in the [config.go](config.go) file.
Ynabber is configured with environment variables. To read from
[Nordigen](https://nordigen.com/en/) (now known as GoCardless) and write to
YNAB use these values:

```bash
cat <<EOT >> ynabber.env
Expand All @@ -31,9 +32,11 @@ NORDIGEN_SECRET_KEY=<nordigen secret key>
EOT
```

All valid config options can be found in the [config.go](config.go) file.

To read the environment variables from a file and run the binary one can use the
[declare](https://www.gnu.org/software/bash/manual/bash.html#index-declare)
command
command:

```bash
# Read environment variables from file and run ynabber
Expand All @@ -56,8 +59,8 @@ docker run \

## Readers

Currently tested readers and verified banks. Any bank supported by
[Nordigen](https://nordigen.com/) (now known as GoCardless) should work.
Currently tested readers and verified banks, but any bank supported by Nordigen
should work.

| Reader | Bank | |
|----------|-----------------|---|
Expand Down

0 comments on commit f63733b

Please sign in to comment.