Update documentation

gatkin · Nov 18, 2019 · 5f9fe57 · 5f9fe57
1 parent 1a16949
commit 5f9fe57
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ dashboards:
 Run the New Relic Dashboard Builder tool to create or update your New Relic dashboards based on the YAML definition file.
 
 ```sh
-nrdash --api-key <YOUR_ADMIN_API_KEY> --account-id <YOUR_ACCOUNT_ID> <DASHBOARD_DEFINITION_YAML_FILE>
+nrdash build --api-key <YOUR_ADMIN_API_KEY> --account-id <YOUR_ACCOUNT_ID> <DASHBOARD_DEFINITION_YAML_FILE>
 ```
 
 ## Documentation

diff --git a/docs/index.md b/docs/index.md
@@ -30,5 +30,5 @@ pip install nrdash
 To use New Relic Dashboard Builder, you must first acquire an [**admin** New Relic API key](https://docs.newrelic.com/docs/insights/insights-api/manage-dashboards/insights-dashboard-api#requirements). Once you have an admin API key, you can configure your New Relic dashboards using the definitions in the YAML definition file by running the `nrdash` command line tool.
 
 ```sh
-nrdash --api-key <YOUR_ADMIN_API_KEY> --account-id <YOUR_ACCOUNT_ID> <DASHBOARD_DEFINITION_YAML_FILE>
+nrdash build --api-key <YOUR_ADMIN_API_KEY> --account-id <YOUR_ACCOUNT_ID> <DASHBOARD_DEFINITION_YAML_FILE>
 ```
diff --git a/docs/reference.md b/docs/reference.md
@@ -5,14 +5,16 @@
 To configure New Relic dashboards based on a YAML definition file, the New Relic Dashboard Builder tool must be invoked from the command line with all required arguments.
 
 ```sh
-Usage: nrdash [OPTIONS] CONFIG_FILE
+Usage: nrdash [OPTIONS] COMMAND [ARGS]...
 
-  Build New Relic dashboards based on YAML configuration.
+  Build New Relic dashboards.
 
 Options:
-  --api-key TEXT        New Relic admin API key  [required]
-  --account-id INTEGER  New Relic account id  [required]
-  --help                Show this message and exit.
+  --help  Show this message and exit.
+
+Commands:
+  build  Build New Relic dashboards based on YAML configuration.
+  lint   Lint New Relic dashboard YAML configuration.
 ```
 
 !!! note