Skip to content

Commit b1edd47

Browse files
Update README.md
1 parent 1031cad commit b1edd47

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ For your convenience, the command will recognize the [environment variable](http
9191
In example, the following command runs [on our Travis-CI](https://travis-ci.org/angular-buch/book-monkey2):
9292

9393
```bash
94-
npx ngh --repo=https://[email protected]/organisation/your-repo.git --name="Displayed Username" [email protected]
94+
npx angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.git --name="Displayed Username" [email protected]
9595
```
9696
> You have to treat the GH_TOKEN as secure as a password!
9797
@@ -100,21 +100,21 @@ npx ngh --repo=https://[email protected]/organisation/your-repo.git --name="Di
100100
## Options
101101

102102
#### <a id="help">--help</a>
103-
* Example: `npx ngh --help`
103+
* Example: `npx angular-cli-ghpages --help`
104104

105105
Output usage information.
106106

107107

108108
#### <a id="version">--version</a>
109-
* Example: `npx ngh --version`
109+
* Example: `npx angular-cli-ghpages --version`
110110

111111
Output the version number. Please provide the version number on any bug report!
112112

113113

114114
#### <a id="repo">--repo</a>
115115
* __optional__
116116
* Default: url of the origin remote of the current dir (assumes a git repository)
117-
* Example: `npx ngh --repo=https://[email protected]/organisation/your-repo.git`
117+
* Example: `npx angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.git`
118118

119119
By default, __gh-pages__ assumes that the current working directory is a git repository,
120120
and that you want to push changes to the `origin` remote.
@@ -125,7 +125,7 @@ you can provide the repository URL in the `repo` option.
125125
#### <a id="message">--message</a>
126126
* __optional__
127127
* Default: `Auto-generated commit`
128-
* Example: `npx ngh --message="What could possibly go wrong?"`
128+
* Example: `npx angular-cli-ghpages --message="What could possibly go wrong?"`
129129

130130
The commit message, __must be wrapped in quotes__.
131131
Some handy additional text is always added,
@@ -135,7 +135,7 @@ if the environment variable `process.env.TRAVIS` exists (for Travis CI).
135135
#### <a id="branch">--branch</a>
136136
* __optional__
137137
* Default: `gh-pages`
138-
* Example: `npx ngh --branch=other-branch`
138+
* Example: `npx angular-cli-ghpages --branch=other-branch`
139139

140140
The name of the branch you'll be pushing to.
141141
The default uses GitHub's `gh-pages` branch,
@@ -145,7 +145,7 @@ but this can be configured to push to any branch on any remote.
145145
#### <a id="name">--name & --email</a>
146146
* __optional__
147147
* Default: value of `git config user.name` and `git config user.email`
148-
* Example: `npx ngh --name="Displayed Username" [email protected]`
148+
* Example: `npx angular-cli-ghpages --name="Displayed Username" [email protected]`
149149

150150
If you are running the command in a repository without a `user.name` or `user.email` git config properties
151151
(or on a machine without these global config properties),
@@ -157,8 +157,8 @@ In this case provide both `name` and `email` string values to identify the commi
157157
* __optional__
158158
* Default: silent `true` (boolean)
159159
* Example:
160-
* `npx ngh` -- Logging is in silent mode by default.
161-
* `npx ngh --no-silent` -- Logging shows extended information.
160+
* `npx angular-cli-ghpages` -- Logging is in silent mode by default.
161+
* `npx angular-cli-ghpages --no-silent` -- Logging shows extended information.
162162

163163
Logging is in silent mode by default.
164164
In silent mode log messages are suppressed and error messages are sanitized.
@@ -186,8 +186,8 @@ which are not related at all to angular.
186186
* __optional__
187187
* Default: dotfiles `true` (boolean)
188188
* Example:
189-
* `npx ngh` -- Dotfiles are included by default.
190-
* `npx ngh --no-dotfiles` -- Dotfiles are ignored.
189+
* `npx angular-cli-ghpages` -- Dotfiles are included by default.
190+
* `npx angular-cli-ghpages --no-dotfiles` -- Dotfiles are ignored.
191191

192192
The command includes dotfiles by default (e.g `.htaccess` will be committed)
193193
With `--no-dotfiles` files starting with `.` are ignored.
@@ -198,16 +198,16 @@ With `--no-dotfiles` files starting with `.` are ignored.
198198
* __optional__
199199
* Default: `undefined`
200200
* Example:
201-
* `npx ngh` -- Normal behaviour: Changes are applied.
202-
* `npx ngh --dry-run` -- No changes are applied at all.
201+
* `npx angular-cli-ghpages` -- Normal behaviour: Changes are applied.
202+
* `npx angular-cli-ghpages --dry-run` -- No changes are applied at all.
203203

204204
Run through without making any changes. This can be very usefull, because it outputs what would happend without doing anything.
205205

206206
#### <a id="cname">--cname</a>
207207
* __optional__
208208
* Default: `No CNAME file is generated`
209209
* Example:
210-
* `npx ngh --cname=example.com`
210+
* `npx angular-cli-ghpages --cname=example.com`
211211

212212
A CNAME file will be created enabling you to use a custom domain. [More information on Github Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
213213

0 commit comments

Comments
 (0)