Merge branch '2.4.0'

README.md

@@ -2,9 +2,34 @@
 
 A Node.js wrapper for the Multicraft API.
 
-To view examples of use, check out the `examples.js` file.
 
-### Updating
+### Example use
+
+`npm i multicraft-api-node`
+
+```
+const MulticraftAPI = require('multicraft-api-node');
+
+const api = new MulticraftAPI({
+    url: "https://localhost/api.php",
+    user: "username",
+    key: "apiKey"
+});
+
+api.listServersByConnection({ connection_id: '1' })
+    .then((data) => console.log(data))
+    .catch((err) => console.error(err));
+
+// {
+//     success: true,
+//     errors: [],
+//     data: { Servers: { '1': 'test', '2': 'Minecraft Server' } }
+// }
+
+```
+To view more examples of use, check out the `examples.js` file.
+
+### Manual Updating
 
 The `methods.json` file automatically generates the functions. To update this file:
 

examples.js

@@ -3,8 +3,8 @@ const MulticraftAPI = require('multicraft-api-node');
 
 const api = new MulticraftAPI({
     url: "https://localhost/api.php",
-    user: "admin",
-    key: "5kd9HaPid@mWqK"
+    user: "username",
+    key: "apiKey"
 });
 
 async function examples() {

methods.json

@@ -181,6 +181,10 @@
 		{
 			"name": "value",
 			"type": "array"
+		},
+		{
+			"name": "details",
+			"default": "0"
 		}
 	],
 	"listServersByConnection": [
@@ -386,6 +390,9 @@
 		"server_id",
 		"daemon_id"
 	],
+	"getMoveStatus": [
+		"server_id"
+	],
 	"listServerPorts": [
 		"id"
 	],
@@ -429,14 +436,26 @@
 	],
 	"getStatistics": [
 		{
-			"name": "daemon_id",
+			"name": "id",
 			"default": 0
 		},
 		{
 			"name": "include_suspended",
 			"default": 0
 		}
 	],
+	"runScript": [
+		"daemon_id",
+		"script",
+		{
+			"name": "args",
+			"default": ""
+		}
+	],
+	"getScript": [
+		"daemon_id",
+		"scriptId"
+	],
 	"listSettings": [],
 	"getSetting": [
 		"key"

package.json

@@ -1,7 +1,7 @@
 {
   "name": "multicraft-api-node",
-  "version": "2.3.0",
-  "description": "API Version 2.3.0",
+  "version": "2.4.0",
+  "description": "API Version 2.4.0",
   "main": "index.js",
   "homepage": "https://github.com/Shockbyte/multicraft-api-node",
   "repository": {