From 5ea2ad97019197d2decf70525b45980b89898f8b Mon Sep 17 00:00:00 2001 From: ChrisChrome Date: Tue, 7 May 2024 21:47:05 -0600 Subject: [PATCH] Actually kinda bother with readme file --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 397313d..e604b79 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ ## Warning -This project is still in development and is not yet ready for use. Please check back later for updates. +This is SUPER tossed together. Might bother cleaning it up later. -It has a lot of hard-coded things, that will eventually be made more flexible via a config/.env file. \ No newline at end of file +## What is this? +This hooks up to the weather.im XMPP server and lets you push messages from iembot to a discord webhook and/or ntfy server topic. + +## 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 \ No newline at end of file