Skip to content

Commit 0d5e59b

Browse files
committed
Update installing instructions
1 parent d663f81 commit 0d5e59b

File tree

2 files changed

+33
-12
lines changed

2 files changed

+33
-12
lines changed

README

Lines changed: 0 additions & 12 deletions
This file was deleted.

README.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Console
2+
=======
3+
4+
A Rails 3 engine for running Ruby scripts on the browser in the context of a controller action.
5+
6+
You can install it as a gem or putting it in your vendor/plugins/console directory.
7+
8+
Installing as a Gem (preferred method)
9+
-------------------------------------
10+
11+
In your Gemfile, put the dependency like this:
12+
13+
<pre>
14+
gem 'rails-web-console', :require => 'console', :group => :development
15+
</pre>
16+
17+
If you intend to use this in production environment (strongly discouraged), be sure to protect console routes. Do it on your own risk!
18+
19+
Installing with a clone
20+
-----------------------
21+
22+
Just put it in your vendor/plugins/console. For instance:
23+
24+
<pre>
25+
git submodule add git://github.com/rosenfeld/rails-web-console.git vendor/plugins/console
26+
</pre>
27+
28+
Usage
29+
-----
30+
31+
Just access "/console" in your browser.
32+
33+
Copyright (c) 2010 [Rodrigo Rosenfeld Rosas], released under the MIT license

0 commit comments

Comments
 (0)