From 144b6ab32e2d1830ef68d35eed35f8c0df1bcf5b Mon Sep 17 00:00:00 2001 From: Arun Babu Neelicattu Date: Thu, 19 Sep 2019 18:09:53 +0200 Subject: [PATCH] Add parameter documentation --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index aea98e2..f4026cc 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,19 @@ This action for [auth0-deploy-cli](https://github.com/auth0/auth0-deploy-cli) en arbitrary actions with the `a0deploy` command, including import and export of tenant configuration. +Refer to the [Auth0 Extensions Documentation](https://auth0.com/docs/extensions/deploy-cli) +for more information on the extension, installation and configuration. + The underlying container used is maintained at [auth0-deploy-cli-container](https://github.com/abn/auth0-deploy-cli-container). +### Parameters +| Argument | Description | +|------------|-------------| +| domain | Full domain for the tenant you are configuring. (eg: `tenant.eu.auth0.com`) | +| id | Auth0 Client ID | +| secret | Auth0 Client Secret | + ### Usage An example configuration deploying tenant configuration from the project where this workflow is running. The tenant input file is expected to be at `./tenant.yml`.