Add docs for kernel slide information

corellium · May 24, 2021 · 02ff5e0 · 02ff5e0
1 parent 51474ce
commit 02ff5e0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -181,6 +181,7 @@ Creates a new instance with the given options. The following options are support
   - `nonjailbroken` The instance should not be jailbroken.
   - `corelliumd` The instance should not be jailbroken but should profile API agent.
 - `options.bootOptions`: Various boot options
+  - `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`
 

diff --git a/src/project.js b/src/project.js
@@ -111,6 +111,8 @@ class Project {
      * @param {string} [options.name] - The device name
      * @param {string} [options.patches] - Instance patches, such as `jailbroken` (default), `nonjailbroken` or `corelliumd` which is non-jailbroken with API agent.
      * @param {Object} [options.bootOptions] - Boot options for the instance
+     * @param {string} [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.
      * @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`
      * @returns {Promise<Instance>}