Skip to content

Commit bf1e5f5

Browse files
eclipse1985polldo
authored andcommitted
Fix minor grammar issues on README (#93)
1 parent 97e5ca8 commit bf1e5f5

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Diff for: README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ This is all you need to use arduino-cloud-cli:
1212

1313
### Additional info
1414

15-
This tool follows a "quiet on success/verbose on error" behaviour. This means that when the execution of a command results in an error, such error is printed. On the other hand, when the command is successfully executed, there is no 'success' feedback on the output: the results of the command, if any, are directly printed without any other feedback informations. This strategy allows users to save the output of the command in a file.
15+
This tool follows a "quiet on success/verbose on error" behaviour. This means that when a command execution result is an error, such error is printed. On the other hand, when the command is successfully executed, there is no 'success' feedback on the output: the results of the command, if any, are directly printed without any other feedback. This strategy allows users to save the output of the command in a file.
1616

17-
However, if the verbose flag `-v` is used, then the behaviour will change: the logs will always be printed out providing users with feedbacks on the execution of the command.
17+
However, if the verbose flag `-v` is used, then the behaviour will change: the logs will always be printed out, providing users with feedback on the execution of the command.
1818

19-
As an example, let's take the `device create`command. We want to save the information of the newly created device in a file.
19+
As an example, let's take the `device create` command. We want to save the information of the newly created device in a file.
2020
So we simply lunch the command:
2121

2222
`$ arduino-cloud-cli device create --name mydevice --format json > mydevice.json`
2323

2424
The resulting mydevice.json will only contain device information in a json format.
2525

26-
Another example: let's say that the execution of the previous command results in an error. In that case the json file will be empty and the terminal will print out the error. Now we want to execute again the command with the logs enabled, in order to understand the issue. So we execute the following:
26+
Another example: let's say that the execution of the previous command results in an error. In that case, the json file will be empty and the terminal will print out the error. Now we want to execute the command again with the logs enabled in order to understand the issue. So we execute the following:
2727

2828
`$ arduino-cloud-cli device create --name mydevice -v`
2929

@@ -37,7 +37,7 @@ Once you have the credentials, execute the following command and provide them:
3737

3838
`$ arduino-cloud-cli credentials init`
3939

40-
By default it will be created in the arduino data directory (arduino15).
40+
By default it will be created in the Arduino data directory (Arduino15).
4141
You can specify a different destination folder with the `--dest-dir` option.
4242
arduino-cloud-cli looks for its credentials file in different directories in the following order: current working directory, parents of the current working directory, arduino15 default directory.
4343

@@ -49,7 +49,7 @@ To reset an old credentials file, just overwrite it using this command:
4949

5050
`$ arduino-cloud-cli credentials init --overwrite`
5151

52-
Credentials file is supported in two different format: json and yaml. Use the `--file-format` to choose it. Default is yaml.
52+
The credentials file is supported in two different formats: json and yaml. Use the `--file-format` to choose it. Default is yaml.
5353

5454
`$ arduino-cloud-cli credentials init --file-format json`
5555

@@ -63,7 +63,7 @@ To have information about which credentials would be used in the current folder
6363

6464
## Device provisioning
6565

66-
When provisioning a device, you can optionally specify the port to which the device is connected to and its fqbn. If they are not given, then the first device found will be provisioned.
66+
When provisioning a device, you can optionally specify the port to which the device is connected and its fqbn. If they are not given, then the first device found will be provisioned.
6767

6868
Use this command to provision a device:
6969

@@ -121,11 +121,11 @@ Delete specific tags of a device. The keys of the tags to delete should be passe
121121

122122
Things can be created starting from a template or by cloning another thing.
123123

124-
Create a thing from a thing template. Supported template formats are JSON and YAML. The name parameter is optional. If it is provided then it overrides the name retrieved from the template:
124+
Create a thing from a thing template. Supported template formats are JSON and YAML. The name parameter is optional. If it is provided, then it overrides the name retrieved from the template:
125125

126126
`$ arduino-cloud-cli thing create --name <thingName> --template <template.(json|yaml)>`
127127

128-
Create a thing by cloning another thing, here the *name is mandatory*:
128+
Create a thing by cloning another thing. Here the *name is mandatory*:
129129

130130
`$ arduino-cloud-cli thing clone --name <thingName> --clone-id <thingToCloneID>`
131131

@@ -208,6 +208,6 @@ Extract a template from an existing dashboard. The template is printed to stdout
208208

209209
`$ arduino-cloud-cli dashboard extract --id <dashboardID> --format <json|yaml>`
210210

211-
Create a dashboard: dashboards can be created only starting from a template. Supported dashboard template formats are JSON and YAML. The name parameter is optional. If it is provided then it overrides the name retrieved from the template. The `override` flag can be used to override the template `thing_id` placeholder with the actual ID of the thing to be used.
211+
Create a dashboard: dashboards can be created only starting from a template. Supported dashboard template formats are JSON and YAML. The name parameter is optional. If it is provided, then it overrides the name retrieved from the template. The `override` flag can be used to override the template `thing_id` placeholder with the actual ID of the thing to be used.
212212

213213
`$ arduino-cloud-cli dashboard create --name <dashboardName> --template <template.(json|yaml)> --override <thing-0>=<actualThingID>,<thing-1>=<otherActualThingID>`

0 commit comments

Comments
 (0)