Skip to content

Commit 69bf3bb

Browse files
Updated "Options" section on README.md
1 parent 4aec382 commit 69bf3bb

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,22 @@ git clone https://github.com/woocommerce/code-reference-generator.git
1212

1313
```bash
1414
cd code-reference-generator
15-
./generate.sh -s <woocommerce_version>
15+
./deploy.sh -s <VERSION>
1616
```
1717

1818
### Options
1919

20-
| Options | Description |
21-
|----------------------------|-----------------------------------------------------------------|
22-
| `-h` or `--help` | Shows help message |
23-
| `-v` or `--version` | Shows generator version |
24-
| `-s` or `--source-version` | Version of the source code to release |
25-
| `-r` or `--github-repo` | GitHub repo with username, default to "woocommerce/woocommerce" |
20+
| Options | Description |
21+
| --------------------------------------------------- | --------------------------------------------------------------------- |
22+
| `-h` or `--help` | Show help information. |
23+
| `-v` or `--verbose` | Increase verbosity. Useful for debugging. |
24+
| `-s <VERSION>` or `--source-version <VERSION>` | Source version to build and deploy. |
25+
| `-r <GITHUB_REPO>` or `--github-repo <GITHUB_REPO>` | GitHub repo with username, default to \"woocommerce/woocommerce\". |
26+
| `-e` or `--allow-empty` | Allow deployment of an empty directory. |
27+
| `-m <MESSAGE>` or `--message <MESSAGE>` | Specify the message used when committing on the deploy branch. |
28+
| `-n` or `--no-hash` | Don't append the source commit's hash to the deploy commit's message. |
29+
| `--build-only` | Only build but not push. |
30+
| `--push-only` | Only push but not build. |
2631

2732
## Changelog
2833

0 commit comments

Comments
 (0)