diff --git a/README.md b/README.md index da9415d..92ea09c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# service-virtfusionservice -A WemX service integration with VirtFusion \ No newline at end of file +# WemX VirtFusion Service Integration +This is a service module for the WemX panel that allows for integration with a VirtFusion panel. + +## Installation +Download from [latest releases](https://git.shadowhosting.xyz/shadow-hosting/wemx-service-virtfusion/releases/latest) + +Extract tar archive into the app/Services folder in your WemX root: + +```bash +sudo tar -xvf wemx-virtfusion.tar.gz -C /var/www/wemx/app/Services +``` + +Set permissions of folder for your webserver: + +```bash +sudo chown -R www-data:www-data /var/www/wemx +``` + +Then finally, run the migrations: +```bash +php artisan migrate --force +``` \ No newline at end of file