README.md in rack-insight-0.5.24 vs README.md in rack-insight-0.5.25
- old
+ new
@@ -1,26 +1,11 @@
Rack::Insight [](https://gemnasium.com/pboling/rack-insight) [](https://codeclimate.com/github/pboling/rack-insight) [](https://travis-ci.org/pboling/rack-insight) [](http://coderwall.com/pboling)
=============
-Rack::Insight began life as an fork of Logical::Insight by LRDesign.
-* I started a fork because:
- * LogicalInsight was namespaced as "Insight"
- * Causing namespace collisions everywhere I have an Insight model. I had to re-namespace all the code.
- * I also needed to build a few extension gems with additional panels, which didn't fully work in LI
- * Added the Config class to allow for custom panel load paths
- and many other extensions that don't work in the *use Middleware* declaration.
-It should be *even* easier to extend than LogicalInsight was, because extension gems can access the Config class
-and truly bolt-on cleanly.
-Having made really significant architectural changes, I'll be keeping Rack::Insight
-a separate project for the foreseeable future.
-
-* Forked From: [logical-insight](http://github.com/LRDesign/logical-insight)
-* Which Was Forked From: [rack-bug](http://github.com/brynary/rack-bug)
-
Description
-----------
Rack::Insight adds a diagnostics toolbar to Rack apps. When enabled, it injects a floating div
allowing exploration of logging, database queries, template rendering times, etc. Rack::Insight
@@ -39,11 +24,11 @@
* Cache
* Templates
* Log (can configure which loggers to watch!)
* Memory
* SQL (Failing specs, and I don't use it, someone please pull me a fix!)
- * Active Record (Failing specs, and I don't use it, someone please pull me a fix!)
+ * Active Record (Thanks to [Kevin Glowacz](https://github.com/kjg) for the fix!)
* Other bundled panels:
* Sphinx (thanks to Oggy for updating this to the rack-insight panel API)
* Redis
* Speedtracer
* Panels under construction:
@@ -151,20 +136,21 @@
require "rack-insight"
ActionController::Dispatcher.middleware.use "Rack::Insight::App",
:secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
- :panel_files => %w[
+ :panel_files => %w(
timer_panel
+ active_record_panel
request_variables_panel
redis_panel
templates_panel
cache_panel
log_panel
- memory_panel,
+ memory_panel
sphinx_panel
- ]
+ )
By default panel files are looked up by prepending "rack/insight/panels/" and requiring them.
Subclasses of Rack::Insight::Panel are loaded and added to the toolbar. This makes
it easier to work with the configuration and extend Rack::Insight with plugin gems.
@@ -258,15 +244,66 @@
Authors
-------
- Maintained by [Peter Boling](mailto:peter.boling@gmail.com)
+ - Contributions from [Kevin Glowacz](https://github.com/kjg) (Fixed Active Record Panel), [Piotr Usewicz](https://github.com/pusewicz) (Use on instead of live), [Nate Greene](https://github.com/natejgreene) (javascript fix), [George Ogata](https://github.com/oggy) (Fixed Redis & Sphinx panels and added AJAX support to them), and [Alif Rachmawadi](https://github.com/subosito) (persistent toolbar position)
- Based on LogicalInsight by Judson Lester
- Contributions from Luke Melia, Joey Aghion, Tim Connor, and more
- Which in turn was based on Rack::Bug by Bryan Helmkamp
+A History of Forking
+--------------------
+
+Rack::Insight began life as an fork of Logical::Insight by LRDesign.
+
+* I started a fork because:
+ * LogicalInsight was namespaced as "Insight"
+ * Causing namespace collisions everywhere I have an Insight model. I had to re-namespace all the code.
+ * I also needed to build a few extension gems with additional panels, which didn't fully work in LI
+ * Added the Config class to allow for custom panel load paths
+ and many other extensions that don't work in the *use Middleware* declaration.
+
+It should be *even* easier to extend than LogicalInsight was, because extension gems can access the Config class
+and truly bolt-on cleanly.
+
+Having made really significant architectural changes, I'll be keeping Rack::Insight
+a separate project for the foreseeable future.
+
+* Forked From: [logical-insight](http://github.com/LRDesign/logical-insight)
+* Which Was Forked From: [rack-bug](http://github.com/brynary/rack-bug)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+6. Create new Pull Request
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver].
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
+
+For example:
+
+ spec.add_dependency 'rack-insight', '~> 0.5'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
Thanks
------
+
Rack::Insight owes a lot to both LogicalInsight and Rack::Bug, as the basis projects. There's a lot of smart
in there. Many thanks to Judson, and Bryan for building them.
Inspiration for Rack::Bug is primarily from the Django debug toolbar.
Additional ideas from Rails footnotes, Rack's ShowException middleware, Oink,