README.rdoc in nirvana-0.1.0 vs README.rdoc in nirvana-0.1.1
- old
+ new
@@ -21,10 +21,33 @@
If you close the tab, the path to nirvana's html page is (for reopening)
$ echo $(dirname $(gem which nirvana))/nirvana/public/index.html
+To see what options nirvana takes (mostly options like ripl):
+
+ $ nirvana -h
+
+Once you're in the nirvana web shell, autocompletion should work better than irb's (argument
+autocompletion):
+
+ >> Bo[TAB]
+ >> Bond
+ >> Bond.const[TAB]
+ Bond.const_defined?
+ Bond.const_get
+ Bond.const_missing
+ Bond.const_set
+ Bond.constants
+ >> Bond.const_g[TAB]
+ >> Bond.const_get :Ag[TAB]
+ >> Bond.const_get :Agent
+
+Also notice that a subset of readline's functionality is available. Try C-l, C-r or C-p and they
+should do what readline normally does. For more keybindings, see
+{readline.js}[http://github.com/cldwalker/readline.js].
+
== Customize
Since nirvana uses ripl under the hood, most shell behavior is customizable with ripl plugins which
get loaded from ~/.riplrc. See {ripl}[http://github.com/cldwalker/ripl] for more.
== Links
@@ -38,11 +61,17 @@
{repl.js}[http://github.com/cldwalker/repl.js/issues] as appropriate.
== Credits
* {rkh's brirb}[http://github.com/rkh/brirb]: Original prototype which inspired this project
+== License
+nirvana is MIT licensed. nirvana comes bundled with other libraries which have the following
+licenses: jquery (GPL2 and MIT), jquery.hotkeys plugin (no license), repl.js jquery plugin (MIT) and
+readline.js jquery plugin (MIT).
+
== Todo
* Tests
+* Easier way to reopen an existing session
* Load ~/.irb_history into readline.js
* Customizable html and js
* Use text area for multi-line input
* See readline.js and repl.js todos for javascript todos
* Possible plugins for sinatra and em-websocket-server