diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b87a7b --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# APRS Discord Bot +Discord.js bot for retrieving station data from https://aprs.fi +!["Bot Snapshot"](https://i.imgur.com/zEMXdkY.png) + +### Demo +You can test it out in the [APRS Discord server](https://discord.gg/2vsqBwp) + +### Installation: + +1. [Follow the guide here for creating your bot](https://anidiots.guide/getting-started/getting-started-long-version) +2. Clone this repository locally +3. Navigate to the bot directory and run `npm install` +4. Rename `config.example.json` to `config.json` and replace the tokens, timezone, and embed color with your own. +5. run `node bot.js` + +### Todos: +- Handle empty/additional fields in the response data for different types of stations