Skip to content

Commit df6bc24

Browse files
committed
fix(docs): correct errors and inconsistencies in README.md
- Fix command name errors: 'bl server list' -> 'bl server create' - Fix capitalization: 'binaryLane' -> 'BinaryLane' - Update image slug: 'ubuntu-22.04-lts' -> 'ubuntu-22.04' - Fix example output: '20.04 LTS' -> '22.04 LTS'
1 parent 4cb1d19 commit df6bc24

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,15 @@ $ bl
7979
8080
usage: bl [OPTIONS] COMMAND
8181
82-
bl is a command-line interface for the binaryLane API
82+
bl is a command-line interface for the BinaryLane API
8383
8484
Options:
8585
--help Display available commands and descriptions
8686
8787
Available Commands:
8888
account Access account commands
8989
action Access action commands
90-
configure Configure access to binaryLane API
90+
configure Configure access to BinaryLane API
9191
domain Access domain commands
9292
image Access image commands
9393
load-balancer Access load-balancer commands
@@ -160,7 +160,7 @@ Server creation is provided by the `bl server create` command. Use `--help` to
160160
view all arguments and parameters:
161161

162162
```
163-
$ bl server list --help
163+
$ bl server create --help
164164
usage: bl server create [OPTIONS] --size SIZE --image IMAGE --region REGION [PARAMETERS]
165165
166166
Create a new server.
@@ -198,7 +198,7 @@ Parameters:
198198
```
199199

200200
In the help displayed by `bl`, **Arguments** are required and **Parameters**
201-
are optional. For the `bl server list` command `--size SIZE`, `--image IMAGE`,
201+
are optional. For the `bl server create` command `--size SIZE`, `--image IMAGE`,
202202
and `--region REGION` are required. A list of available choices for each can be
203203
displayed by running:
204204

@@ -212,7 +212,7 @@ For example, to create a minimum-sized Ubuntu 22.04 LTS server in Sydney using
212212
SSH public key authentication:
213213

214214
```
215-
$ bl server create --size std-min --image ubuntu-22.04-lts --region syd
215+
$ bl server create --size std-min --image ubuntu-22.04 --region syd
216216
completed.
217217
┌───────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────┐
218218
│ name │ value │
@@ -225,7 +225,7 @@ completed.
225225
│ created_at │ 2023-01-20T02:02:32+00:00 │
226226
│ status │ new │
227227
│ region │ Sydney │
228-
│ image │ 20.04 LTS │
228+
│ image │ 22.04 LTS │
229229
│ size │ std-min │
230230
│ size_slug │ std-min │
231231
│ networks │ v4: [{'ip_address': '175.45.180.1', 'type': 'public', 'netmask': '255.255.255.0... │
@@ -245,7 +245,7 @@ For example, to create a server per the previous example with password
245245
authentication:
246246

247247
```
248-
$ bl server create --size std-min --image ubuntu-22.04-lts --region syd --password 'qq7s6GYZgbiVG3'
248+
$ bl server create --size std-min --image ubuntu-22.04 --region syd --password 'qq7s6GYZgbiVG3'
249249
```
250250

251251
Upon completion, the root password for the server in this example would be `qq7s6GYZgbiVG3`.
@@ -350,7 +350,7 @@ soon as the BinaryLane API accepts the requested command. To do so, include the
350350
`--async` option in the command invocation. For example:
351351

352352
```
353-
$ bl server create --size std-min --image ubuntu-22.04-lts --region syd --async
353+
$ bl server create --size std-min --image ubuntu-22.04 --region syd --async
354354
```
355355

356356
### Configuration file

0 commit comments

Comments
 (0)