Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

doc changes for multiple guards to init

  • Loading branch information...
commit 787d5b6c215ad3c3f22323f966e41afa2d09920c 1 parent 004723c
@jredville jredville authored
View
2  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
View
7 README.md
@@ -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`:
View
4 man/guard.1
@@ -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\.
View
6 man/guard.1.html
@@ -126,12 +126,12 @@ <h3 id="start">start</h3>
<p><code>-p</code>, <code>--force-polling</code>
Force usage of the Listen polling listener.</p>
-<h3 id="init-GUARD-">init [GUARD]</h3>
+<h3 id="init-GUARDS-">init [GUARDS]</h3>
<p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
-<p>If <var>GUARD</var> is present, add its default Guardfile configuration to the current Guardfile.
-Note that <var>GUARD</var> is the Guard plugin name without the <code>guard-</code> prefix.
+<p>If <var>GUARDS</var> are present, add their default Guardfile configuration to the current Guardfile.
+Note that <var>GUARDS</var> is a list of the Guard plugin names without the <code>guard-</code> prefix.
For instance to initialize guard-rspec, run <code>guard init rspec</code>.</p>
<h3 id="list">list</h3>
View
8 man/guard.1.ronn
@@ -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
Please sign in to comment.
Something went wrong with that request. Please try again.