Skip to content

Fix typo in README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brandonjones24 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typo in README.md #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Sync [ActualBudget](https://actualbudget.com/) via [SimpleFIN](https://beta-bridge.simplefin.org/)
## PREREQUISITES
- A [SimpleFIN Token](https://beta-bridge.simplefin.org/) is required during **setup**
- The [ActualBduget Budget ID](https://actualbudget.com/docs/developers/using-the-API/#getting-started) is required during **setup**
- The [ActualBudget Budget ID](https://actualbudget.com/docs/developers/using-the-API/#getting-started) is required during **setup**
- ActualBudget needs to be installed and running
- Have your SimpleFin setup key handy. These are 1 time use only, so if for some reason you abort your setup early, you may need to generate a new one. If you re-run config, after a succesful setup, you won't need to change this unless you've deleted it from SimpleFin (stores the AccessKey returned).
- Once you get everything running, you may (optionally) configure a system cron to run this automatically.
Expand All @@ -17,23 +17,23 @@ Sync [ActualBudget](https://actualbudget.com/) via [SimpleFIN](https://beta-brid
## TODO
- Better security for storage of SimpleFIN AccessKey
- Allow custom date ranges for sync

## USAGE
- **Sync** - If the app hasn't been configured yet, you'll be run through the setup steps, otherwise it will sync the current month for all accounts.
- **Sync** - If the app hasn't been configured yet, you'll be run through the setup steps, otherwise it will sync the current month for all accounts.
```
node app.js
```

- **Setup** - Change your SimpleFIN token, which budget file to use, your Actual Budget url, Actual Budget Password,and how the accounts are linked.
- **Setup** - Change your SimpleFIN token, which budget file to use, your Actual Budget url, Actual Budget Password,and how the accounts are linked.
```
node app.js --setup
```

- **Link** - Change or add any new linked accounts
- **Link** - Change or add any new linked accounts
```
node app.js --link
```

## TROUBLESHOOTING

- I've had some users report trouble using .local addresses to connect. If you run into this and are able, a reverse proxy might be of assistance.
Expand Down