Readme.md in rack-webconsole-0.0.1 vs Readme.md in rack-webconsole-0.0.3
- old
+ new
@@ -2,18 +2,19 @@
Rack-webconsole is a Rack-based interactive console (à la Rails console) in
your web application's frontend. That means you can interact with your
application's backend from within the browser itself!
-To get a clearer idea, you can check out [this video](
-http://youtu.be/yKK5J01Dqts?hd=1) showing a live example :)
+To get a clearer idea, you can check out this video showing a live example :)
+[](http://youtu.be/yKK5J01Dqts?hd=1)
+
Rack-webconsole is a Rack middleware designed to be unobtrusive. With Rails 3,
for example, you only have to include the gem in your Gemfile and it already
works. Without any configuration.
-Tested with MRI 1.9.2 and ruby-head (1.9.3).
+Tested with MRI versions 1.8.7, 1.9.2, ruby-head, and JRuby 1.6.3.
##Resources
* [Example video](http://youtu.be/yKK5J01Dqts?hd=1)
* [Documentation](http://rubydoc.info/github/codegram/rack-webconsole)
@@ -22,11 +23,19 @@
In your Gemfile:
gem 'rack-webconsole'
+Rack-webconsole **needs JQuery**. If you are using Rails 3, JQuery is loaded by
+default. In case you don't want to use JQuery in your application,
+**rack-webconsole can inject it for you** only when it needs it. To do that you
+should put this line somewhere in your application (a Rails initializer, or
+some configuration file):
+ Rack::Webconsole.inject_jquery = true
+
+
##Usage with Rails 3
If you are using Rails 3, you have no further steps to do. It works! To give
it a try, fire up the Rails server and go to any page, press the ` ` ` key and
the console will show :)
@@ -52,10 +61,11 @@
NOTE: If you are using Bundler and initializing it from config.ru, you don't
have to `require 'rack/webconsole'` manually, otherwise you have to.
And it works! Fire up the server, go to any page and press the ` ` ` key.
+
##Commands
In the console you can issue whatever Ruby commands you want, except multiline commands. Local variables are kept, so you can get a more IRB-esque feeling.
To reset all local variables, just issue the `reload!` command.
@@ -80,8 +90,7 @@
* Send us a pull request. Bonus points for topic branches.
## Copyright
Copyright (c) 2011 Codegram. See LICENSE for details.
-