Added documentation

Author: gshutler

LICENSE

@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,6 +1,9 @@
-# Check::Js
+# Browser Details
 
-TODO: Write a gem description
+Browser Details is a Rack Middleware that logs information about the browser
+used to make a request.
+
+When possible this includes whether the browser has Javascript enabled or not.
 
 ## Installation
 
@@ -16,9 +19,34 @@ Or install it yourself as:
 
     $ gem install browser_details
 
-## Usage
+### Rails
+
+The middleware will be installed automatically by the Railtie.
+
+To enable Browser Details to report whether the browser has Javascript enabled
+for form submissions you must add the following line to your
+`app/assets/javascripts/application.js`:
+
+    //= require browser_details
+
+Browser Details requires jQuery to be present as it works by checking if the
+`utf8` form element has been changed to a large tick from a small tick by the
+Browser Details Javascript.
+
+If this script is not added then all browsers will report that Javascript is
+disabled.
+
+### Other Rack applications
+
+To use the Browser Details middleware you must add the line:
+
+    use BrowserDetails
+
+Wherever it may be appropriate for your application.
 
-TODO: Write usage instructions here
+The Javascript detection is currently reliant on Rails. If you would like your
+application to be able to detect whether Javascript is enabled too, please
+create an issue, or even better open a pull request.
 
 ## Contributing
 

browser_details.gemspec

@@ -4,9 +4,15 @@ require File.expand_path('../lib/browser_details/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Garry Shutler"]
   gem.email         = ["garry@robustsoftware.co.uk"]
-  gem.description   = %q{TODO: Write a gem description}
-  gem.summary       = %q{TODO: Write a gem summary}
-  gem.homepage      = ""
+  gem.description   = %q{
+    Browser Details is a Rack Middleware that logs information about the browser
+    used to make a request
+  }
+  gem.summary       = %q{
+    Browser Details is a Rack Middleware that logs information about the browser
+    used to make a request
+  }
+  gem.homepage      = "https://github.com/gshutler/browser_details"
 
   gem.files         = Dir.glob(File.join(File.dirname(__FILE__), 'lib', '**', '*'))
   gem.name          = "browser_details"