From c3e7e0753294cf024b66a3d7296306695f4623bf Mon Sep 17 00:00:00 2001
From: Juan Cruz Viotti <jviotti@openmailbox.org>
Date: Tue, 21 Feb 2017 17:43:25 -0400
Subject: [PATCH] docs: group CLI developer oriented documentation at
 lib/cli/README.md (#1105)

Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
---
 docs/CLI.md       | 31 -------------------------------
 lib/cli/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 31 deletions(-)
 create mode 100644 lib/cli/README.md

diff --git a/docs/CLI.md b/docs/CLI.md
index 57a2187b..20a3c431 100644
--- a/docs/CLI.md
+++ b/docs/CLI.md
@@ -43,34 +43,3 @@ Options
   --yes, -y      confirm non-interactively
   --unmount, -u  unmount on success
 ```
-
-The robot option
-----------------
-
-Setting the `ETCHER_CLI_ROBOT` environment variable allows other applications
-to easily consume the output of the Etcher CLI in real-time. When using the
-`ETCHER_CLI_ROBOT` option, the `--yes` option is implicit, therefore you need
-to manually specify `--drive`.
-
-When `ETCHER_CLI_ROBOT` is used, the program will output JSON lines containing
-the progress state and other useful information. For example:
-
-```
-$ sudo etcher image.iso --robot --drive /dev/disk2
-{"command":"progress","data":{"type":"write","percentage":1,"eta":130,"speed":1703936}}
-...
-{"command":"progress","data":{"type":"check","percentage":100,"eta":0,"speed":17180514}}
-{"command":"done","data":{"sourceChecksum":"27c39a5d"}}
-```
-
-The `command` property can be used to determine the action taking place, while
-the `data` property contains extra information related to the command.
-
-Exit codes
-----------
-
-The Etcher CLI uses certain exit codes to signal the result of the operation.
-These are documented in [`lib/shared/exit-codes.js`][exit-codes] and are also
-printed on the Etcher CLI help page.
-
-[exit-codes]: https://github.com/resin-io/etcher/blob/master/lib/shared/exit-codes.js
diff --git a/lib/cli/README.md b/lib/cli/README.md
new file mode 100644
index 00000000..8c0f7b94
--- /dev/null
+++ b/lib/cli/README.md
@@ -0,0 +1,46 @@
+Etcher CLI
+==========
+
+The Etcher CLI is a command line interface to the Etcher writer backend, and
+currently the only module in the "Etcher" umbrella that makes use of this
+backend directly.
+
+This module also has the task of unmounting the drives before and after
+flashing.
+
+Notice the Etcher CLI is not worried about elevation, and assumes it has enough
+permissions to continue, throwing an error otherwise. Consult the
+[`lib/child-writer`][child-writer] module to understand how elevation works on
+Etcher.
+
+The robot option
+----------------
+
+Setting the `ETCHER_CLI_ROBOT` environment variable allows other applications
+to easily consume the output of the Etcher CLI in real-time. When using the
+`ETCHER_CLI_ROBOT` option, the `--yes` option is implicit, therefore you need
+to manually specify `--drive`.
+
+When `ETCHER_CLI_ROBOT` is used, the program will output JSON lines containing
+the progress state and other useful information. For example:
+
+```
+$ sudo ETCHER_CLI_ROBOT=1 etcher image.iso --drive /dev/disk2
+{"command":"progress","data":{"type":"write","percentage":1,"eta":130,"speed":1703936}}
+...
+{"command":"progress","data":{"type":"check","percentage":100,"eta":0,"speed":17180514}}
+{"command":"done","data":{"sourceChecksum":"27c39a5d"}}
+```
+
+See documentation about the robot mode at [`lib/shared/robot`][robot].
+
+Exit codes
+----------
+
+The Etcher CLI uses certain exit codes to signal the result of the operation.
+These are documented in [`lib/shared/exit-codes.js`][exit-codes] and are also
+printed on the Etcher CLI help page.
+
+[exit-codes]: https://github.com/resin-io/etcher/blob/master/lib/shared/exit-codes.js
+[robot]: https://github.com/resin-io/etcher/tree/master/lib/shared/robot
+[child-writer]: https://github.com/resin-io/etcher/tree/master/lib/child-writer