IEM-Alert/README.md

19 lines
557 B
Markdown

## Warning
This is SUPER tossed together. Might bother cleaning it up later.
## What is this?
This is meant to be a public Discord bot. It connects via XMPP to Weather.IM and allows server owners to subscribe a channel to any number of weather alerts.
## How do I use this?
1. Clone the repo
2. Install the requirements
3. Copy `config.example.json` to `config.json` and fill in the values
4. Run `node .`
5. Profit?
## TODO
- [ ] Clean up the code
- [ ] Add more error handling
- [ ] Add more logging
- [ ] Add more features
- [ ] Add more documentation