Permalink
Browse files

Documentation tweaks

  • Loading branch information...
1 parent e3b2eff commit f13a1867dbd28601dff1a0f5c26330dbb41ef3fb @drbrain committed Mar 2, 2012
Showing with 25 additions and 10 deletions.
  1. +11 −9 README.rdoc
  2. +14 −1 lib/hoe/travis.rb
View
@@ -11,24 +11,26 @@ http://travis-ci.org. The plugin contains a <code>.travis.yml</code>
generator and a pre-defined rake task which runs the tests and ensures your
manifest file is correct.
-With hoe-travis, additional checks and setup can be added with
-locally-verifiable rake tasks instead of committing and pushing a change,
-waiting for travis to run your tests, then trying a new commit if you didn't
-fix the problem.
+With hoe-travis it is easy to add additional checks. Custom checks can be
+easily verified locally by simply running a rake task instead of committing
+and pushing a change, waiting for travis to run your tests, then trying a new
+commit if you didn't fix the problem.
== Features
* .travis.yml generation task
* Pre-defined rake tasks which are run by travis-ci
-* Easy to hook up rake tasks for additional travis-ci setup and checks
+* Easy to hook up rake tasks for additional travis-ci setup or checks
-== Install
+== Getting Started
- sudo gem install hoe-travis
+If you're not already using Hoe with your project, see: http://docs.seattlerb.org/hoe/Hoe.pdf
+
+To get started with hoe-travis, first install it:
-== Synopsis
+ sudo gem install hoe-travis
-Add hoe-travis as a plugin to your Rakefile:
+Then add hoe-travis as a plugin to your Rakefile:
Hoe.plugin :travis
View
@@ -31,7 +31,8 @@
# http://travis-ci.org/profile underneath your github username and email
# address.
#
-# To set this in your hoerc run `rake config_hoe` and edit the "token:" entry.
+# To set this in your hoerc run <code>rake config_hoe</code> and edit the
+# "token:" entry.
#
# == Tasks
#
@@ -58,6 +59,18 @@
# up in your EDITOR and runs travis-lint upon saving. Does not allow you to
# save a bad .travis.yml.
#
+# travis:enable::
+# Enables the travis hook on github.com. Requires further setup as
+# described below.
+#
+# travis:disable::
+# Disables the travis hook on github.com. Requires further setup as
+# described below.
+#
+# travis:force::
+# Forces a travis-ci run, equivalent to clicking the "test" button on the
+# travis-ci hook page.
+#
# == Hoe Configuration
#
# The Hoe configuration is used to generate the .travis.yml. After you've

0 comments on commit f13a186

Please sign in to comment.