Document command

kgryte · kgryte · commit 2decf78d54d1 · 2019-08-09T08:54:09.000-07:00
diff --git a/lib/node_modules/@stdlib/repl/README.md b/lib/node_modules/@stdlib/repl/README.md
@@ -917,6 +917,29 @@ Stops saving commands to a file path associated with a specified record identifi
 // TODO
 ```
 
+#### tutorial( \[text, \[options]] )
+
+Starts a tutorial.
+
+```text
+In [1]: var id = tutorial( 'repl' );
+```
+
+The function accepts the following `options`:
+
+-   **borderTop**: top border character sequence. Default: `'*'`.
+-   **borderBottom**: bottom border character sequence. Default: `'*'`.
+-   **borderLeft**: left border character sequence. Default: `'* '`.
+-   **borderRight**: right border character sequence. Default: `' *'`.
+-   **counter**: slide counter. Can either be `true`, `false`, or `'progress'`. Default: `progress`.
+-   **workspace**: REPL workspace name. A tutorial [presentation][@stdlib/repl/presentation] adds commands to the specified workspace, thus allowing tutorial navigation and interaction. Default: `'tutorial-<name>-<n>'`, where `name` is the tutorial `name` and `n` is an assigned tutorial [presentation][@stdlib/repl/presentation] identifier.
+-   **autoClear**: `boolean` indicating whether to automatically clear the screen before writing a rendered tutorial slide to the REPL. Default: `true`.
+
+A few notes:
+
+-   When not provided a tutorial `name`, the function returns a list of available tutorials.
+-   If a specified workspace already exists, the workspace is silently cleared and a new tutorial [presentation][@stdlib/repl/presentation] bound. In order to preserve an existing workspace, specify an alternative tutorial workspace name.
+
 #### userDoc( alias, \[ref,] doc )
 
 Adds user-defined documentation.
