typos in README

master
Wouter Groeneveld 2 years ago
parent 4d687cd22e
commit 75ce65b3e7

@ -16,12 +16,12 @@ If you'd like to let a specific buddy chat - for instance to configure them indi
`yarn toot --buddy [by-cool-buddy]`
The name shouldl match the `buddy` property in the config file (_not_ the `name` property: that's the buddy directory name).
The name should match the `buddy` property in the config file (_not_ the `name` property: that's the buddy directory name).
### Packaged buddies
1. **animalcrossing**: collect data from https://animalcrossing.fandom.com/wiki/ and randomly toot about a villager, including a link to the fandom and the birthday. Uses dirty scraping, no rate limit hit yet...
2. **mobygames**: collect data through the moby games API so you'll need an API key: https://www.mobygames.com/info/api - the API is rate-limited at one call per second and 360 per hour. The above working example posts a random Game Boy game with two screenshots collected via the API. It's generic, so just configure `platform` in the config file (10 is GB).
1. **animalcrossing**: collect data from https://animalcrossing.fandom.com/wiki/ and randomly toot about a villager, including a link to the Fandom page and the birthday. Uses dirty scraping, no rate limit hit yet...
2. **mobygames**: collect data through the Moby Games API so you'll need an API key: https://www.mobygames.com/info/api - the API is rate-limited at one call per second and 360 per hour. The above working example posts a random Game Boy game with two screenshots collected via the API. It's generic, so just configure `platform` in the config file (10 is GB).
### Creating a new buddy
@ -56,8 +56,8 @@ Optional config flags can be used in the chat function if desired.
There's a sanity check implemented: at minimum, each config should have name, buddy, instance, and oauthToken present.
## How to get an OAuth token from a Masto?Pleroma instance?
## How to get an OAuth token from a Masto/Pleroma instance?
I've prepared a few utility functions in `registerApp.js` for you. First, call `await register()`, which prints an URL to go to. Next, fill in the client id, secret, and returned token, after granting the app access to read and write. Then, call `await fetchToken()`. Paste that token in the config file. Done!
Token refreshing is not (yet) implemented. Most tokens are valid for a year or so. Who knows what'll happen then.
Token refreshing is not (yet) implemented. Most tokens are valid for a year or so. Who knows what'll happen by then.

Loading…
Cancel
Save