From: Valerie Pond <redacted>
Date: Wed, 4 Jan 2023 17:06:34 +0000 (+0000)
Subject: Update README.md
X-Git-Tag: 0.9~601
X-Git-Url: https://jfr.im/git/irc/unrealircd/unrealircd-webpanel.git/commitdiff_plain/922a4534045f1cdb25bff5dfed61638d5aa628e0

Update README.md
---

diff --git a/README.md b/README.md
index 52a6cdb..3022c85 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,37 @@
  UnrealIRCd Administration WebPanel
  
  <img src="https://i.ibb.co/7jtddG4/Screenshot-from-2022-12-31-04-53-35.png">
-(wuuuut)
+
+## Prerequisites ##
+- PHP 7 or later
+- A webserver
+- UnrealIRCd 6.0.5
+
+## Installation ##
+
+Note: This instructional assumes this is going to be hosted in the webroot directory `/var/www/` (html/) directory.
+You may want to hide this somehow. Well, you definitely should. I don't know how to do that though. Sorry.
+
+Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue.
+
+1. First, if you have just installed apache2 or something else, remove the `html` directory and navigate to `/var/www/`
+```
+cd /var/www/
+rm -rf html
+```
+
+2. Clone this repository to a new directory called `html`
+```
+git clone https://github.com/ValwareIRC/unrealircd-webpanel html
+```
+
+3. Move into the `html` directory and edit the configuration file
+```
+cd html
+nano config.php
+```
+The file will look like this:<br>
+<img src="https://i.ibb.co/zZ7LsXD/Screenshot-from-2023-01-04-17-03-20.png">
+
+Edit the configuration file to match your UnrealIRCd's RPC credentials and save
+