Permalink
Browse files

fixing docs

  • Loading branch information...
1 parent a501668 commit 8fdb5eda551d81d40c92e646fe717209f8382f74 Rob Lingle committed Jun 5, 2009
Showing with 24 additions and 19 deletions.
  1. +0 −19 README.rdoc
  2. +24 −0 README.textile
View
@@ -1,19 +0,0 @@
-= Moonshine_Scout
-
-=== A plugin for Moonshine[http://github.com/railsmachine/moonshine]
-
-A plugin for installing and managing the {Scout reporting agent}[http://github.com/highgroove/scout_agent/tree/master]. You'll need to have an existing {Scout account}[http://scoutapp.com to use this plugin].
-
-At a minimum, you'll need to configure the Scout agent key for your server. This key will be provided
-at the time you add a server, and is also available under the Server Admin section.
-
-For other options, have a look at @templates/scout_agent.rb.erb@
-
-=== Instructions
-
-* <tt>script/plugin install git://github.com/railsmachine/moonshine_scout.git</tt>
-* Configure settings
- configure( :scout => { :agent_key => 'YOUR-PRIVATE-SCOUT-KEY'} )
-* Include the plugin and recipe(s) in your Moonshine manifest
- plugin :scout
- recipe :scout
View
@@ -0,0 +1,24 @@
+h1. Moonshine_Scout
+
+h3. A plugin for "Moonshine":http://github.com/railsmachine/moonshine
+
+A plugin for installing and managing the "Scout reporting agent":http://github.com/highgroove/scout_agent/tree/master. You'll need to have an existing "Scout account":http://scoutapp.com to use this plugin.
+
+At a minimum, you'll need to configure the Scout agent key for your server. This key will be provided at the time you add your server to Scout, and is also available under the Server Admin section of the site.
+
+For other options, have a look at @templates/scout_agent.rb.erb@
+
+*Note:* This does not install the "Rails Instrumentation":http://github.com/highgroove/scout_rails_instrumentation plugin for Scout. You'll need to install and configure that separately.
+
+h3. Instructions
+
+* @script/plugin install git://github.com/railsmachine/moonshine_scout.git@
+* Configure settings
+ <pre>
+ configure( :scout => { :agent_key => 'YOUR-PRIVATE-SCOUT-KEY'} )
+ </pre>
+* Include the plugin and recipe(s) in your Moonshine manifest
+ <pre>
+ plugin :scout
+ recipe :scout
+ </pre>

0 comments on commit 8fdb5ed

Please sign in to comment.