From 413858e03f48b77a8b05787f7a1ee565b00c380a Mon Sep 17 00:00:00 2001 From: Tim Strazzere Date: Thu, 27 May 2021 15:54:55 -0700 Subject: [PATCH] Add docs for additionTags - kalloc and remote gpu --- README.md | 3 +++ src/project.js | 3 +++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 9ad5443..4a35df7 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,9 @@ Creates a new instance with the given options. The following options are support - `options.bootOptions.kernelSlide`: Change the Kernel slide value for an iOS device. When not set, the slide will default to zero. When set to an empty value, the slide will be randomized. - `options.bootOptions.udid`: Predefined Unique Device ID (UDID) for iOS device - `options.bootOptions.screen`: Change the screen metrics for Ranchu devices `XxY[:DPI]`, e.g. `720x1280:280` + - `options.bootOptions.additionalTags[]`: An array of addition features to utilize for the device, valid options include + - `kalloc`: Enable kalloc/kfree trace access via GDB (Enterprise only) + - `gpu`: Enable cloud GPU acceleration (Extra costs incurred, cloud only) Example: diff --git a/src/project.js b/src/project.js index 81036f9..4999c1d 100644 --- a/src/project.js +++ b/src/project.js @@ -115,6 +115,9 @@ class Project { * When not set, the slide will default to zero. When set to an empty value, the slide will be randomized. * @param {string} [options.bootOptions.udid] - Predefined Unique Device ID (UDID) for iOS device * @param {string} [options.bootOptions.screen] - Change the screen metrics for Ranchu devices `XxY[:DPI]`, e.g. `720x1280:280` + * @param {string[]} [options.bootOptions.additionalTags] - Addition features to utilize for the device, valid options include:
+ * `kalloc` : Enable kalloc/kfree trace access via GDB (Enterprise only)
+ * `gpu` : Enable cloud GPU acceleration (Extra costs incurred, cloud only) * @returns {Promise} * * @example Creating an instance and waiting for it to start its first boot