Update README.md

README.md

@@ -1,3 +1,30 @@
-# ircBridgeV3
+# ircBridgeV3 
+## WORK IN PROGRESS
 
-version 3 of the ircBridge
+### IRC bridge to site chatbox
+#### Version 3
+
+**This app is built to join and listen on the selected IRC channel handling cross communications between the channel and site chatbox.**
+
+**Includes:**
+- User verification and validation
+- Staff channel management
+- Cross application communications
+
+**To install:**
+>[!NOTE]
+>These instructions are set up to install the app into it's own virtual environment
+- Clone the project
+- Move the service file to `/etc/systemd/system/ircbridge.service`
+- Set appropriate settings in config.yml and gunicorn_config.py
+- Set up python venv in dir
+  - `$ cd <directory>`
+  - `$ python -m venv venv`
+  - `$ source venv/bin/activate`
+  - `$ pip install -r requirements.txt`
+  - `$ deactivate`
+- Edit the service file to reflect proper paths
+- Enable and start the service
+  - `$ sudo systemctl enable ircbridge.service`
+  - `$ sudo systemctl start ircbridge.service`
+  - Use `journalctl -u ircbridge -f` to monitor