@@ -760,13 +760,12 @@ You may also need to pay attention to the values of `max_queued_events` and `max
Create a Guard
-Creating a new Guard is very easy, just create a new gem by running `bundle gem guard-name`, where `name` is
-the name of your Guard. Please make your Guard start with `guard-`, so that it can easily be found on RubyGems.
+Creating a new Guard is very easy. For example, to create a Guard named `yoyo` just create a new gem by running `bundle gem guard-yoyo`. Please make your Guard start with `guard-`, so that it can easily be found on RubyGems.
-$ mkdir guard-name
-$ cd guard-name
-$ bundle gem guard-name
+$ mkdir guard-yoyo
+$ cd guard-yoyo
+$ bundle gem guard-yoyo
Now extend the project structure to have an initial Guard:
@@ -775,31 +774,31 @@ Now extend the project structure to have an initial Guard:
.travis.yml # bonus point!
CHANGELOG.md # bonus point!
Guardfile # needed for `guard init <guard-name>`
test/ # or spec/
-Your Guard main class `Guard::GuardName` in `lib/guard/guard-name.rb` must inherit from
+Your Guard main class `Guard::Yoyo` in `lib/guard/guard-yoyo.rb` must inherit from
[Guard::Guard](http://rubydoc.info/github/guard/guard/master/Guard/Guard) and should overwrite at least the
`#run_on_change` task methods.
-Here is an example scaffold for `lib/guard/guard-name.rb`:
+Here is an example scaffold for `lib/guard/yoyo.rb`:
-classGuardName < Guard
+classYoyo < Guard
# Initialize a Guard.
# @param [Array<Guard::Watcher>] watchers the Guard file watchers