Skip to content

Commit

Permalink
doc changes for multiple guards to init
Browse files Browse the repository at this point in the history
  • Loading branch information
jredville committed Jul 6, 2012
1 parent 004723c commit 787d5b6
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,7 @@
## Master

- Add support for multiple guards being passed to `guard init`. ([@jredville][])

### 1.2.1 - 2 Juli, 2012

### Bug fix
Expand Down
7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -225,6 +225,13 @@ in the generated Guardfile:
$ guard init <guard-name>
```

You can also specify the names of multiple plugins to only get those plugin templates
in the generated Guardfile:

```bash
$ guard init <guard1-name> <guard2-name>
```

You can also define your own templates in `~/.guard/templates/` which can be appended in the same way to your existing
`Guardfile`:

Expand Down
4 changes: 2 additions & 2 deletions man/guard.1
Expand Up @@ -53,11 +53,11 @@ The following options are available:
.P
\fB\-p\fR, \fB\-\-force\-polling\fR Force usage of the Listen polling listener\.
.
.SS "init [GUARD]"
.SS "init [GUARDS]"
If no Guardfile is present in the current directory, creates an empty Guardfile\.
.
.P
If \fIGUARD\fR is present, add its default Guardfile configuration to the current Guardfile\. Note that \fIGUARD\fR is the Guard plugin name without the \fBguard\-\fR prefix\. For instance to initialize guard\-rspec, run \fBguard init rspec\fR\.
If \fIGUARDS\fR are present, add their default Guardfile configuration to the current Guardfile\. Note that \fIGUARDS\fR is a list of the Guard plugin names without the \fBguard\-\fR prefix\. For instance to initialize guard\-rspec, run \fBguard init rspec\fR\.
.
.SS "list"
Lists Guard plugins that can be used with the \fBinit\fR command\.
Expand Down
6 changes: 3 additions & 3 deletions man/guard.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/guard.1.ronn
Expand Up @@ -47,19 +47,19 @@ The following options are available:

`--show-deprecations`
Turn on deprecation warnings.

`-l`, `--latency`
Overwrite Listen's default latency.

`-p`, `--force-polling`
Force usage of the Listen polling listener.

### init [GUARD]
### init [GUARDS]

If no Guardfile is present in the current directory, creates an empty Guardfile.

If <GUARD> is present, add its default Guardfile configuration to the current Guardfile.
Note that <GUARD> is the Guard plugin name without the `guard-` prefix.
If <GUARDS> are present, add their default Guardfile configuration to the current Guardfile.
Note that <GUARDS> is a list of the Guard plugin names without the `guard-` prefix.
For instance to initialize guard-rspec, run `guard init rspec`.

### list
Expand Down

0 comments on commit 787d5b6

Please sign in to comment.