Skip to content

Commit

Permalink
Update README and CHANGELOG.
Browse files Browse the repository at this point in the history
  • Loading branch information
netzpirat committed Jun 13, 2012
1 parent f7070f9 commit fa4f2bd
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 6 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## Master

### Improvements

- Add a [Coolline](https://github.com/Mon-Ouie/coolline) based interactor (Ruby 1.9.3 only). ([@netzpirat][])
- More flexible command parser for all interactors. ([@netzpirat][])
- Add 'show' command to describe all plugins in the interactor. ([@netzpirat][])
- Add 'change' command to trigger a file change event in the interactor. ([@netzpirat][])

## 1.1.1 - 3 June, 2012

### Bug fix
Expand Down
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,8 @@ You can interact with Guard and enter commands when Guard has nothing to do. Gua
* ``: Run all Guards.
* `h`, `help`: Show a help of the available interactor commands.
* `r`, `reload`: Reload all Guards.
* `c`, `change`: Show a help of the available interactor commands.
* `s`, `show`: Show Guard plugin configuration.
* `n`, `notification`: Toggle system notifications on and off.
* `p`, `pause`: Toggles the file modification listener. The prompt will change to `p>` when paused.
This is useful when switching Git branches, rebase Git or change whitespace.
Expand Down Expand Up @@ -426,6 +428,18 @@ This will reload only the Ronn Guard. You can also reload all Guards within a gr
> backend reload
```

The action and plugin or group name can have any order, so you can also write:

```bash
> reload backend
```

You can pass a list of filenames to the `change` command to trigger manually a file modification:

```bash
> change spec/guard_spec.rb
```

### Readline support

With Readline enabled, you'll see a command prompt `>` when Guard is ready to accept a command. The command line
Expand All @@ -443,6 +457,18 @@ end
Guard will automatically enable Readline support if your environment supports it, but you can disable Readline with the
`interactor` DSL method or turn off completely with the `--no-interactions` option.

### Coolline support

With Ruby 1.9.3 you can use a [Coolline](https://github.com/Mon-Ouie/coolline) based interactor, which uses the new
`io/console` from stdlib. Just add it to your `Gemfile`

```ruby
gem 'coolline'
```

Guard will automatically enable Coolline support if your environment supports it, but you can disable Coolline with the
`interactor` DSL method or turn off completely with the `--no-interactions` option.

### Signals

You can also interact with Guard by sending POSIX signals to the Guard process (all but Windows).
Expand Down Expand Up @@ -591,15 +617,11 @@ notification :off

### interactor

You can disable the interactor auto detection and for a specific implementation:
You can disable the interactor auto detection and select a specific implementation:

```ruby
interactor :coolline
interactor :readline
```

will select Readline interactor. You can also force the simple interactor without Readline support with:

```ruby
interactor :simple
```

Expand Down

0 comments on commit fa4f2bd

Please sign in to comment.