Skip to content

Commit

Permalink
Add documentations for the new behavior of the init task and the bare…
Browse files Browse the repository at this point in the history
… option
  • Loading branch information
Maher4Ever committed Jan 27, 2012
1 parent 360080f commit 665813f
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Expand Up @@ -201,26 +201,41 @@ $ guard help start


### Init ### Init


You can generate an empty `Guardfile` by running the `init` task: You can generate a Guardfile and have all installed guards be automatically added into
it by running the `init` task without any option:


```bash ```bash
$ guard init $ guard init
``` ```


In addition, the `init` task can be used to append a supplied Guard template from an installed Guard to your existing You can also specify the name of an installed Guard to only get that Guard
`Guardfile`: in the generated Guardfile:


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


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


```bash ```bash
$ guard init <template-name> $ guard init <template-name>
``` ```


**Note**: If you already have a `Guardfile` in the current directory, the `init` task can be used
to append a supplied Guard template from an installed Guard to your existing
`Guardfile`.

#### `-b`/`--bare` option

You can generate an empty `Guardfile` by running the `init` task with the bare
option:

```bash
$ guard init --bare
$ guard init -b # shortcut
```

### Start ### Start


Just launch Guard inside your Ruby or Rails project with: Just launch Guard inside your Ruby or Rails project with:
Expand Down Expand Up @@ -832,7 +847,7 @@ When you file an issue, please try to follow to these simple rules if applicable
* Add your `Guardfile` and `Gemfile` to the issue. * Add your `Guardfile` and `Gemfile` to the issue.
* Make sure that the issue is reproducible with your description. * Make sure that the issue is reproducible with your description.


Development [![Dependency Status](https://gemnasium.com/guard/guard.png?branch=master)](https://gemnasium.com/guard/guard) Development [![Dependency Status](https://gemnasium.com/guard/guard.png?branch=master)](https://gemnasium.com/guard/guard)
----------- -----------


* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard/master/frames). * Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard/master/frames).
Expand Down

0 comments on commit 665813f

Please sign in to comment.