Skip to content

Commit 8c5f0d7

Browse files
docs(readme): Updated to reflect latest help ui
1 parent 221ba5e commit 8c5f0d7

1 file changed

Lines changed: 24 additions & 16 deletions

File tree

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# branchsite
22

3-
Heavily inspired by [`np`](https://github.com/sindresorhus/np), this provides a complimentary tool that eases the process of publishing your static files to a branch (e.g. gh-pages) via the use of `git subtree`.
3+
Heavily inspired by [`np`](https://github.com/sindresorhus/np), this provides a complimentary tool that eases the process of publishing your static files to a branch (e.g. gh-pages).
44

55
[![Build Status](https://travis-ci.org/enriquecaballero/branchsite.svg?branch=master)](https://travis-ci.org/enriquecaballero/branchsite) [![Greenkeeper badge](https://badges.greenkeeper.io/enriquecaballero/branchsite.svg)](https://greenkeeper.io/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![semantic-release](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
66

@@ -13,21 +13,29 @@ $ yarn global add branchsite
1313
```
1414
$ bs --help
1515
16-
Usage: bs [options]
17-
18-
Options:
19-
20-
-h, --help output usage information
21-
--any-branch Allow pushing from any branch
22-
--no-yarn Don't use Yarn
23-
-C, --commit <commit> Optional commit message
24-
--no-commit Don't commit
25-
--stage Stage files while using --no-commit
26-
--no-push Don't push to branch
27-
-H, --hook <hook> NPM hook that builds your static website
28-
-D, --directory <path> Directory that will be pushed to separate branch
29-
-B, --branch <branch> Branch that will be used as subtree
30-
-R, --remote <remote> Repository that will be pushed to
16+
bs - CLI tool for publishing your static website to a separate branch
17+
18+
USAGE
19+
20+
bs
21+
22+
OPTIONS
23+
24+
--any-branch Allow pushing from any branch optional
25+
--no-yarn Don't use Yarn optional
26+
--no-publish Don't publish optional
27+
--no-cleanup Will skip the clean up stage optional
28+
--hook <hook> NPM hook that builds your static website optional
29+
--directory <path> Directory that will be pushed to separate branch optional
30+
--branch <branch> Branch that will be used for deployment optional
31+
32+
GLOBAL OPTIONS
33+
34+
-h, --help Display help
35+
-V, --version Display version
36+
--no-color Disable colors
37+
--quiet Quiet mode - only displays warn and error messages
38+
-v, --verbose Verbose mode - will also output debug messages
3139
```
3240

3341
## Contributing

0 commit comments

Comments
 (0)