From 3fc5596d893b21a08c02b0ca1e7849b69070d48e Mon Sep 17 00:00:00 2001
From: Andrew Murray <andrewmurray@ezscale.cloud>
Date: Sun, 10 Sep 2023 17:53:30 -0400
Subject: [PATCH] Updated README.md

---
 README.md                                  | 28 ++++++++++++++++++++++
 modules/servers/VirtFusionDirect/README.md |  8 -------
 2 files changed, 28 insertions(+), 8 deletions(-)
 create mode 100644 README.md
 delete mode 100644 modules/servers/VirtFusionDirect/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..759f692
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# VirtFusion Direct Provisioning Module for WHMCS
+
+This module requires VirtFusion v1.7.3 or higher as this is what it's based on. Please refer to the official [documenataion](https://docs.virtfusion.com/integrations/whmcs).
+
+## Installation
+
+1. Download the latest release from the [releases](https://github.com/EZSCALE/virtfusion-whmcs-module/releases) page.
+2. Extract the contents of the archive and upload the modules folder to your WHMCS installation directory.
+
+## Configuration
+
+You'll need to configure the following constraints in your `configuration.php` file.
+This is only temporary and will be replaced with pulling the token from the database in the future.
+
+```php
+// VirtFusion API URL
+const VIRTFUSION_API_URL = "https://your-virtfusion-url.com/api/v1";
+
+// VirtFusion API Token
+const VIRT_TOKEN = "your-virtfusion-token";
+```
+
+## What does this module change?
+
+This module changes the following things:
+
+- Adds configurable options to the product configuration page to allow the user to select the operating system and add
+  a ssh key to the initial deployment.
\ No newline at end of file
diff --git a/modules/servers/VirtFusionDirect/README.md b/modules/servers/VirtFusionDirect/README.md
deleted file mode 100644
index 952b8f1..0000000
--- a/modules/servers/VirtFusionDirect/README.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# VirtFusion Direct Provisioning Module for WHMCS
-
-This module requires VirtFusion v1.7.3 or higher as this is what it's based on. Please refer to the official [documenataion](https://docs.virtfusion.com/integrations/whmcs).
-
-## Changes in this module
-
-- Allows using the configurable options quantity method for assigning Memory in Gigabytes instead of Megabyte. So you can use whole numbers to represent GB instead.
-For example, prior to this change for two gigabytes of RAM you'd need to set 2048 as either the min or max amount, now you can just input 2 for 2GB.