Permalink
Browse files

Improve README and CHANGELOG

  • Loading branch information...
1 parent 04cd472 commit 280ccf96fbbba6a087daa967bd156ece7943c002 @rymai rymai committed Aug 16, 2012
Showing with 85 additions and 28 deletions.
  1. +72 −0 CHANGELOG.md
  2. +1 −1 LICENSE
  3. +12 −27 README.md
View
@@ -0,0 +1,72 @@
+## Master
+
+### Bug fix
+
+- [#11][] Fix an issue that was causing `(deadlock; recursive locking)` errors due to body not closed. ([@rymai][])
+
+### Improvements
+
+- [#11][] Usage of Bundler. ([@rymai][])
+- [#11][] Addition of development dependencies. ([@rymai][])
+- [#11][] Creation of `lib/rack-google-analytics.rb` so `:require => 'rack/google-analytics'` in the Gemfile shouldn't needed anymore. ([@rymai][])
+
+## 0.10.0
+
+### Improvements
+
+- Include the Google pagespeed code.
+- `README` typos fixed.
+
+## 0.9.2
+
+### Bug fix
+
+- Fixed a bug with lots of missing files from the Gem... how silly!
+
+## 0.9.1
+
+### Improvement
+
+- Updated `README` to reflect 0.9.0 merge from achiu.
+
+## 0.9.0
+
+### Improvement
+
+- Name changed from 'rack-google-analytics' to 'rack/google-analytics' more inline with the norm.
+
+## 0.6.0
+
+### Improvement
+
+- Class now named `Rack::GoogleAnalytics`, in 0.5 and earlier this was incorrectly documented as `Rack::GoogleTracker`.
+
+## 0.2.0
+
+### Improvement
+
+- Asynchronous code is now the default.
+
+## 22 Jul, 2010
+
+### Improvement
+
+- Major re-write from Arthur Chiu, now correctly writes the `Content-Length` header, and comes with tests. ([@achiu][])
+- This patch also backs-out the changes from [@cimm][] - but they were un-tested (I intend to bring these back as soon as possible; this will probably constitute a 1.0 release when it happens).
+
+## 19 Jan, 2010
+
+### Improvement
+
+- Makes the default snippet the async version from Google. Use regular synchronous code with: `:async => false`. ([@ralph][])
+
+## 27 Dec, 2009
+
+ - Initial release, extracted from the Capistrano-Website project.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#11]: https://github.com/jilion/rack/issues/11
+[@achiu]: https://github.com/achiu
+[@cimm]: https://github.com/cimm
+[@ralph]: https://github.com/ralph
+[@rymai]: https://github.com/rymai
View
@@ -1,4 +1,4 @@
-Copyright (c) 2009 Lee Hambley
+Copyright (c) 2009-2012 Lee Hambley
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
@@ -1,15 +1,13 @@
# Rack google Analytics
-Simple Rack middleware to help injecting the google analytics tracking code into the footer of your websites.
+Simple Rack middleware to help injecting the Google Analytics tracking code in your website.
-This middleware injects either the synchronous or asynchronous google analytics tracker code into the correct place of any request with `Content-Type` containing `html` (therefore `text/html` and similar).
-
-Formerly this gem had an environments setting, that has been removed pending refactoring.
+This middleware injects either the synchronous or asynchronous Google Analytics tracking code into the correct place of any request only when the response's `Content-Type` header contains `html` (therefore `text/html` and similar).
## Usage
-#### Gemfile:
- gem 'rack-google-analytics', :require => 'rack/google-analytics'
+#### Gemfile
+ gem 'rack-google-analytics'
#### Sinatra
## app.rb
@@ -20,41 +18,28 @@ Formerly this gem had an environments setting, that has been removed pending ref
## app/app.rb
use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
-#### Rails
+#### Rails 2.X
## environment.rb:
config.gem 'rack-google-analytics', :lib => 'rack/google-analytics'
config.middleware.use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x'
### Options
-* :async - sets to use asyncronous tracker
-* :multiple - sets track for multiple sub domains. (must also set :domain)
-* :top_level - sets tracker for multiple top-level domains. (must also set :domain)
+* `:async` - sets to use asynchronous tracker
+* `:multiple` - sets track for multiple subdomains. (must also set :domain)
+* `:top_level` - sets tracker for multiple top-level domains. (must also set :domain)
-Note: since 0.2.0 this will use the asynchronous google tracker code, for the traditional behaviour please use:
+Note: since 0.2.0 this will use the asynchronous Google Analytics tracking code, for the traditional behaviour please use:
use Rack::GoogleAnalytics, :tracker => 'UA-xxxxxx-x', :async => false
-If you are not sure what's best, go with the defaults, and read here if you should opt-out
+If you are not sure what's best, go with the defaults, and read here if you should opt-out.
## Thread Safety
This middleware *should* be thread safe. Although my experience in such areas is limited, having taken the advice of those with more experience; I defer the call to a shallow copy of the environment, if this is of consequence to you please review the implementation.
-## Change Log
-
-* 0.10.0 Include the Google pagespeed code, and `README` typos fixed.
-* 0.9.2 Fixed a bug with lots of missing files from the Gem... how silly!
-* 0.9.1 Updated readme to reflect 0.9.0 merge from achiu
-* 0.9.0 Include name changed from 'rack-google-analytics' to 'rack/google-analytics' more inline with the norm
-* 0.6.0 Class now named Rack::GoogleAnalytics, in 0.5 and earlier this was incorrectly documented as Rack::GoogleTracker
-* 0.2.0 Asynchronous code is now the default.
-
-* 22-07-2010 Major re-write from Arthur Chiu, now correctly writes the Content-Length leader, and comes with tests (High five to @achiu) - this patch also backs-out the changes from @cimm - but they were un-tested (I intend to bring these back as soon as possible; this will probably constitute a 1.0 release when it happens)
-* 19-01-2010 Second Release, patch from github.com/ralph - makes the default snippet the async version from google. Use regular synchronous code with: `:async => false`
-* 27-12-2009 First Release, extracted from the Capistrano-Website project and packaged with Jeweler.
-
## Note on Patches/Pull Requests
* Fork the project.
@@ -67,5 +52,5 @@ This middleware *should* be thread safe. Although my experience in such areas is
## Copyright
-Copyright (c) 2009-2011 Lee Hambley. See LICENSE for details.
-With thanks to Ralph von der Heyden http://github.com/ralph/ and Simon `cimm` Schoeters http://github.com/cimm/ - And the biggest hand to Arthur `achiu` Chiu for the huge work that went into the massive 0.9 re-factor.
+Copyright (c) 2009-2012 Lee Hambley. See LICENSE for details.
+With thanks to [Ralph von der Heyden](https://github.com/ralph) and [Simon Schoeters](https://github.com/cimm) - And the biggest hand to [Arthur Chiu](https://github.com/achiu) for the huge work that went into the massive 0.9 re-factor.

0 comments on commit 280ccf9

Please sign in to comment.