Add docs for additionTags - kalloc and remote gpu

corellium · May 27, 2021 · 413858e · 413858e
1 parent 02ff5e0
commit 413858e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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:<br>
+     * `kalloc` : Enable kalloc/kfree trace access via GDB (Enterprise only)<br>
+     * `gpu` : Enable cloud GPU acceleration (Extra costs incurred, cloud only)
      * @returns {Promise<Instance>}
      *
      * @example <caption>Creating an instance and waiting for it to start its first boot</caption>