Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README and LICENSE

  • Loading branch information...
commit 913ab4b1cc283c0497a2eb1259a0a3824fa5361e 1 parent 9996500
Ben Askins benaskins authored
Showing with 16 additions and 10 deletions.
  1. +1 −1  LICENSE
  2. +15 −9 README.rdoc
2  LICENSE
View
@@ -1,4 +1,4 @@
-Copyright (c) 2009 Ben Askins
+Copyright (c) 2009 Plus2
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
24 README.rdoc
View
@@ -1,6 +1,6 @@
= whereuat
-Adds a toolbar to your rails app that directs your clients to test stories that have been marked as 'delivered' in Pivotal Tracker.
+Adds a slide out panel to your rails app that directs clients to test stories that have been marked as 'delivered' in Pivotal Tracker.
== Installing
@@ -8,23 +8,23 @@ Add whereuat to your Gemfile:
gem 'whereuat'
-Create an initializer to configure your pivotal tracker api token and project id:
+Create an initializer to add the Whereuat::RackApp to your middleware stack and configure your pivotal tracker api token and project id:
+
+ require 'whereuat'
+ Rails.configuration.middleware.use(Whereuat::RackApp)
Whereuat.configure do |config|
config.pivotal_tracker_token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
config.pivotal_tracker_project = 123456
end
-Add the Whereuat::RackApp to your middleware stack (in your environment.rb file):
-
- require 'whereuat'
- config.middleware.use(Whereuat::RackApp)
-
Use the following helper somewhere in your application layout (we recommend at the end of the body):
= whereuat
-The helper will insert a smidgeon of javascript (jquery is assumed to be available) that will add a tiny toolbar to your view.
+The helper will insert a smidgeon of javascript (jquery is assumed to be available) that will add a tiny tab on the LHS
+of each page.
+
Reload a page from your app and give it a whirl.
== Note on Patches/Pull Requests
@@ -37,6 +37,12 @@ Reload a page from your app and give it a whirl.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
+== Contributors
+
+Ben Askins
+Lachie Cox
+Ben Webster
+
== Copyright
-Copyright (c) 2010 Ben Askins. See LICENSE for details.
+Copyright (c) 2010 Plus2. See LICENSE for details.
Please sign in to comment.
Something went wrong with that request. Please try again.