branch: elpa/inf-ruby
commit c353603f1f31ff14a21038212d6285798d79ea07
Merge: b31b7d3061 171c4e9e38
Author: Dmitry Gutov <[email protected]>
Commit: Dmitry Gutov <[email protected]>
Merge pull request #68 from Trevoke/patch-1
Clarify the "usage" section
---
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 42403a321d..ced93834bc 100644
--- a/README.md
+++ b/README.md
@@ -74,23 +74,24 @@ Prelude user you can start using it right away.
## Usage
+### IRB
A simple IRB process can be fired up with <kbd>M-x inf-ruby</kbd>.
+### Project
To launch a REPL with project-specific console instead, type <kbd>M-x
inf-ruby-console-auto</kbd>.
It recognizes several project types, including Rails, gems and anything with
`racksh` in their Gemfile.
Customization: When entered, this mode runs `comint-mode-hook` and
`inf-ruby-mode-hook` (in that order).
-You can send text to the inferior Ruby process from other buffers containing
-Ruby source.
+### Commands
* `ruby-switch-to-inf` switches the current buffer to the ruby process buffer.
* `ruby-send-definition` sends the current definition to the ruby process.
* `ruby-send-region` sends the current region to the ruby process.
* `ruby-send-definition-and-go` and `ruby-send-region-and-go` switch to the
ruby process buffer after sending their text.
-Commands:
+### Keybindings
* <kbd>RET</kbd> after the end of the process' output sends the text from the
end of process to point.
