Skip to content

Commit e607b5b

Browse files
Update README.md
1 parent 07a1c2b commit e607b5b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Made for Travis-CI. Brought to you by the [angular-buch.com](https://angular-buc
1616
## About
1717

1818
This script is similar to the normal `github-pages:deploy` command.
19-
But by design, the command is limited to the `gh-pages` branch of the same repository.
19+
But by design, the command is limited to the `gh-pages` branch of the same repository.
20+
__New: The deploy command is being removed from the core of the CLI very soon! [#4385](https://github.com/angular/angular-cli/pull/4385)__
21+
2022

2123
In contrast to this, the [angular-buch/angular-cli-ghpages](https://github.com/angular-buch/angular-cli-ghpages) script is able to push to any branch on any repository. It's made on top of [tschaub/gh-pages](https://github.com/tschaub/gh-pages).
2224
__This script works great on [Travis-CI](https://travis-ci.org/).__ No git credentials must be set up in before. Specific environment variables of Travis-CI are evaluated, too. You will like it!
@@ -39,11 +41,12 @@ npm i -g angular-cli-ghpages
3941
## Usage
4042

4143
Execute `angular-cli-ghpages` in order to deploy the project with a build from `dist` folder.
42-
Note: you have to create the folder in before (e.g. `ng build --prod`)
44+
__Note: you have to create the `dist` folder in before (e.g. `ng build --prod`)__
4345

4446
Usage:
4547

4648
```sh
49+
ng build
4750
angular-cli-ghpages [OPTIONS]
4851
```
4952

@@ -53,6 +56,8 @@ there is also a shorter `ngh` command available
5356
ngh [OPTIONS]
5457
```
5558

59+
If you want to push to `gh-pages` on the same repository with your default credentials, then just enter `ngh` without any options.
60+
5661
## Options
5762

5863
#### <a id="repo">--repo</a>
@@ -132,4 +137,4 @@ angular-cli-ghpages --repo=https://[email protected]/organisation/your-repo.gi
132137
Code released under the [MIT license](https://opensource.org/licenses/MIT).
133138

134139
[npm-url]: https://www.npmjs.com/package/angular-cli-ghpages
135-
[npm-image]: https://badge.fury.io/js/angular-cli-ghpages.svg
140+
[npm-image]: https://badge.fury.io/js/angular-cli-ghpages.svg

0 commit comments

Comments
 (0)