From 96cbd7c8d23168105936ad0be559efd33d85d745 Mon Sep 17 00:00:00 2001 From: Pierce Date: Sun, 30 Dec 2018 20:47:22 -0500 Subject: [PATCH] making docs more accurate --- README.md | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b9d06fc..48dee81 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ A script that launches Minecraft using NodeJS. | Parameter | Type | Description | Required | |------------------|----------|-------------------------------------------------------------------------------------------|----------| -| `authorization` | Object | The result from `getAuth` function, allows the client to login in online or offline mode. | True | -| `clientPackage` | String | Path to the client package zip file. | False | -| `root` | String | Path where you want the launcher to work in. like `C:/Users/user/AppData/Roaming/.mc` | True | -| `os` | String | windows, osx or linux | True | -| `version.number` | String | Minecraft version that is going to be launched. | True | -| `version.type` | String | Any string. The actual Minecraft launcher uses `release` and `snapshot`. | True | -| `memory.max` | String | Max amount of memory being used by Minectaft | True | +| `options.authorization` | Object | The result from `getAuth` function, allows the client to login in online or offline mode. | True | +| `options.clientPackage` | String | Path to the client package zip file. | False | +| `options.root` | String | Path where you want the launcher to work in. like `C:/Users/user/AppData/Roaming/.mc` | True | +| `options.os` | String | windows, osx or linux | True | +| `options.version.number` | String | Minecraft version that is going to be launched. | True | +| `options.version.type` | String | Any string. The actual Minecraft launcher uses `release` and `snapshot`. | True | +| `options.memory.max` | String | Max amount of memory being used by Minectaft | True | #### launcher.authenticator Functions diff --git a/package.json b/package.json index f23cf86..31d0b1e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "minecraft-launcher-core", - "version": "1.0.4", + "version": "1.0.5", "description": "Module that downloads Minecraft assets and runs Minecraft.", "main": "index.js", "dependencies": {