Skip to content

Commit 88b796a

Browse files
Update README.md
1 parent 6801123 commit 88b796a

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,23 @@ ngh [OPTIONS]
7272

7373
If you want to push to `gh-pages` on the same repository with your default credentials, then just enter `ngh` without any options.
7474

75-
## Options
7675

7776

77+
## Extra
78+
79+
For your convenience, the command will recognize the [environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings) `GH_TOKEN` and will replace this pattern in the `--repo` string. Please __do NOT disable the silent mode__ if you have any credentials in the repository URL! Read more about [Github tokens here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
80+
81+
In example, the following command runs [on our Travis-CI](https://travis-ci.org/angular-buch/book-monkey2):
82+
83+
```bash
84+
angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.git --name="Displayed Username" [email protected]
85+
```
86+
> You have to treat the GH_TOKEN as secure as a password!
87+
88+
89+
90+
## Options
91+
7892
#### <a id="help">--help</a>
7993
* Example: `ngh --help`
8094

@@ -177,16 +191,7 @@ With `--no-dotfiles` files starting with `.` are ignored.
177191

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

180-
## Extra
181-
182-
For your convenience, the command will recognize the [environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings) `GH_TOKEN` and will replace this pattern in the `--repo` string. Please __do NOT disable the silent mode__ if you have any credentials in the repository URL! Read more about [Github tokens here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
183-
184-
In example, the following command runs [on our Travis-CI](https://travis-ci.org/angular-buch/book-monkey2):
185194

186-
```bash
187-
angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.git --name="Displayed Username" [email protected]
188-
```
189-
> You have to treat the GH_TOKEN as secure as a password!
190195

191196
## FAQ
192197

0 commit comments

Comments
 (0)