docs(readme): wording and structural tweaks for Acrolinx

This has changes based on grammar and style things from Acrolinx. This keeps the public doc and this readme file the same.
This commit is contained in:
Vivian Liu 2018-09-13 11:35:01 -07:00 коммит произвёл Jeff Principe
Родитель 9fe90e5641
Коммит 3a7a5b4946
1 изменённых файлов: 14 добавлений и 18 удалений

Просмотреть файл

@ -3,21 +3,19 @@
Command-line interface for interacting with Azure IoT Central devices and
applications.
## Installing
## Prerequisites
+ Node.js version 8.x or higher - https://nodejs.org
+ You will need Administrator access in IoT Central to generate an access token
To use `iotc-explorer`, you will need to have the following installed:
## Installing `iotc-explorer`
* Node.js version 8.x or higher - https://nodejs.org
Once you have the prerequisites installed, run the following from your command
line to install:
Run the following command from your command line to install:
```
npm install -g iotc-explorer
```
> NOTE: You will typically need to run the install command with `sudo` in
Unix-like environments.
> NOTE: You will typically need to run the install command with `sudo` in Unix-like environments.
Once installed, you can run `iotc-explorer --help` to verify everything is
working and get an overview of the available commands:
@ -47,14 +45,12 @@ Below are some commands and common options that you can run when using
### Login
Before you get going, you need to have an administrator of your IoT
Central application to get an access token for you to use. The administrator
takes the following steps:
* Go to **Administration/Access Tokens**.
* Click **Generate**, and enter a Token name.
* Click **Next**, and **copy the Token value**.
Before you get going, you need to have an administrator of your IoT Central application to get an access token for you to use. The administrator takes the following steps:
- Go to **Administration/Access Tokens**.
- Click **Generate**, and enter a Token name.
- Click **Next**, and **copy the Token value**.
> NOTE: The Token value will only be shown once, so it must be copied before closing the dialog. After closing the dialog, it will never be shown again.
> NOTE: The token value will only be shown once, so it must be copied before closing the dialog. After closing the dialog, it will never be shown again.
You can then use that token to log in to the CLI by running:
@ -75,13 +71,13 @@ You can watch the messages coming from either a specific device or all devices
in your application using the `monitor-messages` command. This will start a
watcher that will continuously output new messages as they come in.
To watch all devices in your application, simply run:
To watch all devices in your application, run the following command:
```
iotc-explorer monitor-messages
```
To watch a specific device, just add the device's id to the end of the command:
To watch a specific device, just add the Device ID to the end of the command:
```
iotc-explorer monitor-messages <your-device-id>
@ -97,7 +93,7 @@ iotc-explorer monitor-messages --raw
### Get Device Twin
You can use the `get-twin` command to get the contents of the twin for an IoT
Central device. To do so, simply run the following:
Central device. To do so, run the following command:
```
iotc-explorer get-twin <your-device-id>