Updated "Options" section on README.md

woocommerce · Aug 18, 2020 · 69bf3bb · 69bf3bb
1 parent 4aec382
commit 69bf3bb
Showing 1 changed file with 12 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -12,17 +12,22 @@ git clone https://github.com/woocommerce/code-reference-generator.git
 
 ```bash
 cd code-reference-generator
-./generate.sh -s <woocommerce_version>
+./deploy.sh -s <VERSION>
 ```
 
 ### Options
 
-| Options                    | Description                                                     |
-|----------------------------|-----------------------------------------------------------------|
-| `-h` or `--help`           | Shows help message                                              |
-| `-v` or `--version`        | Shows generator version                                         |
-| `-s` or `--source-version` | Version of the source code to release                           |
-| `-r` or `--github-repo`    | GitHub repo with username, default to "woocommerce/woocommerce" |
+| Options                                             | Description                                                           |
+| --------------------------------------------------- | --------------------------------------------------------------------- |
+| `-h` or `--help`                                    | Show help information.                                                |
+| `-v` or `--verbose`                                 | Increase verbosity. Useful for debugging.                             |
+| `-s <VERSION>` or `--source-version <VERSION>`      | Source version to build and deploy.                                   |
+| `-r <GITHUB_REPO>` or `--github-repo <GITHUB_REPO>` | GitHub repo with username, default to \"woocommerce/woocommerce\".    |
+| `-e` or `--allow-empty`                             | Allow deployment of an empty directory.                               |
+| `-m <MESSAGE>` or `--message <MESSAGE>`             | Specify the message used when committing on the deploy branch.        |
+| `-n` or `--no-hash`                                 | Don't append the source commit's hash to the deploy commit's message. |
+| `--build-only`                                      | Only build but not push.                                              |
+| `--push-only`                                       | Only push but not build.                                              |
 
 ## Changelog