Show helpful error message if php-mbstring is not installed

[irc/unrealircd/unrealircd-webpanel.git] / README.md

diff --git a/README.md b/README.md
index f3ca909fa688cd19098dcfd842d45b6dce536c69..e277b49ebd233b96928057af69f1e605349ab058 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,70 +1,24 @@
-# unrealircd-webpanel
- UnrealIRCd Administration WebPanel
+ ## UnrealIRCd Administration WebPanel
  
- <img src="https://i.ibb.co/7SdFZnk/Screenshot-from-2023-01-14-07-26-21.png">
-
-## Prerequisites ##
-- PHP 8 or later
-- A webserver
-- UnrealIRCd 6.0.6-git recommended. Minimal functionality available with UnrealIRCd 6.0.5.
-
-Note: PHP 8 may require special installation instructions.
-Here are some instructions for:
-- [Ubuntu 20/22](https://linuxhint.com/install-php-8-ubuntu-22-04/)
-- [Debian](https://www.vultr.com/docs/how-to-install-php-8-on-debian-11/)
-- [CentOS](https://www.tecmint.com/install-php-8-on-centos/)
-
-For more installation methods for PHP 8, make a websearch for how to install PHP 8 on your operating system.
-## 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.
+[![Version](https://img.shields.io/badge/UnrealIRCd-6.0.6_or_later-darkgreen.svg)]()
+[![Version](https://img.shields.io/badge/Version-Beta-blue.svg)]()
+[![Maintained](https://img.shields.io/badge/Maintained-yes-darkgreen.svg)]()
+[![Unreal](https://img.shields.io/badge/PHP-8.0_or_later-darkgreen.svg)](https://unrealircd.org)
 
-Please make sure you have [correctly setup UnrealIRCd for use with JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) before you continue.
+The UnrealIRCd Administration WebPanel gives you an overview of your IRC network,
+with detailed information about servers, users and channels.
+You can easily add and remove server bans, spamfilters and do other administrative tasks,
+all from the convenience of your web browser.
 
-- Go to your webserver root, for example `/var/www/html/`, and clone
-  this repository:
-```
-cd /var/www/html
-git clone https://github.com/unrealircd/unrealircd-webpanel
-```
-
-- Go into the directory and run composer to install the dependencies
-  (If you don't have composer, then [install it](https://getcomposer.org/download/) first):
-```
-cd unrealircd-webpanel
-composer install
-```
-
-- Edit the configuration file
-```
-cp config.php.sample config.php
-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
-
-NOTE: You most likely want to put the webpanel behind a login, using a
-`.htaccess` file or similar.
+## Example Overview from Desktop
+ <img src="https://i.ibb.co/7SdFZnk/Screenshot-from-2023-01-14-07-26-21.png">
+ <img src="https://i.ibb.co/6vQ6wg7/spamfilter.png">
 
-## Updating for end-users ##
-For end-users, when you want to update to the latest version:
-```bash
-git pull
-composer update
-```
+## Example Overview from Mobile
+<div class="row">
+<img src="https://i.ibb.co/KGLdB43/Screenshot-20230123-233804-Chrome.jpg" height="30%" width="30%">
+<img src="https://i.ibb.co/tB980kd/Screenshot-20230124-000204-Chrome.jpg" height="30%" width="30%">
+</div>
 
-## Developers ##
-Developers of the webpanel will naturally use the same procedure as
-above. However, sometimes you will want to update to a newer version
-of the unrealircd-rpc-php library. You then need to run:
-```bash
-# For devs only!
-composer install
-git commit composer.lock
-```
-Commiting the composer.lock file updates the dependency for all
-other users, that way a `composer update` by end-users will update
-to exactly the version that `composer install` just installed.
+## Installation ##
+See https://www.unrealircd.org/docs/UnrealIRCd_webpanel for all documentation.