Skip to content

Commit

Permalink
command-line-tutorial: minor improvements
Browse files Browse the repository at this point in the history
- Use admontion syntax around a warning
- Improve language for terseness
  • Loading branch information
philips committed Jul 16, 2024
1 parent 6352185 commit 036ee28
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/command-line-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,9 @@ To get started, you'll need:

### Install `divviup`

`divviup` is a command line (CLI) tool for doing all basic operations on both
the Divvi Up API and Distributed Aggregation Protocol (DAP) API endpoints. It's
only likely to work if the leader aggregator is
[Janus](https://github.com/divviup/janus). See `divviup --help` for details on
all of the commands.
`divviup` is a command line (CLI) tool for doing basic operations on the Divvi
Up and Distributed Aggregation Protocol (DAP) API endpoints. See
`divviup --help` for details on all of the commands.

The tool is available for download for macOS, Windows or Linux from the
[divviup-api releases page](https://github.com/divviup/divviup-api/releases).
Expand Down Expand Up @@ -212,11 +210,15 @@ The output will be like:
Saved new collector credential to /your/current/directory/collector-credential-144.json. Keep this file safe!
```

:::warning

**Note**: This credential isn't sensitive because it's only useful in your local
instance of Divvi Up. But collector credentials generated against the production
service should be carefully managed. Consider using a password manager to
protect them.

:::

Make a note of the path where the credential was saved, and save the collector
credential ID to an environment variable.

Expand Down

0 comments on commit 036ee28

Please sign in to comment.