Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SathyaBhat committed Apr 28, 2024
1 parent d5dfee6 commit 63bf70f
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
### ynab-exporter

A simple Prometheus exporter for You Need A Budget (YNAB) budgeting data.
A simple Prometheus exporter for [You Need A Budget](https://www.ynab.com)(YNAB) budgeting data.

### How do I get started?

- Build the Docker image

```bash
# replace sathyabhat/ynab-exporter with your own tag
docker build . -t sathyabhat/ynab-exporter
```

- Export the following environment variables:

* `YNAB_TOKEN` - API token from [YNAB](https://api.ynab.com/).
* `BUDGET_ID` - The id corresponding to your YNAB budget. Soon, this exporter will fetch and publish data from all budgets.

- Run the exporter

```bash
docker run --rm -e YNAB_TOKEN -e BUDGET_ID -p -d sathyabhat/ynab-exporter
```

The exporter will start listening on the port that you provide as a `PORT` environment variable, or on 9100 if you don't provide it.

### Feedback/suggestions

If you have any feedback/suggestions, please [open a Github issue](https://github.com/SathyaBhat/ynab-exporter/issues/new).

0 comments on commit 63bf70f

Please sign in to comment.