branch: externals/ruby-end
commit 5e84c0c2fd7fc99be2e35a8ba2bbc978f9f1aa72
Author: Johan Andersson <[email protected]>
Commit: Johan Andersson <[email protected]>
Update README.
---
README.markdown | 40 +++++++++++++++++++++++++++++++++++-----
1 file changed, 35 insertions(+), 5 deletions(-)
diff --git a/README.markdown b/README.markdown
index 20ea169153..01e4e8896c 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,7 +1,37 @@
-# ruby-end
+# Ruby end
+Ruby end is a minor mode for Emacs that can be used with `ruby-mode`
+to automatically close blocks by inserting `end` when typing a "block
+keyword", followed by a space.
-ruby-end is a minor mode for Emacs that can be used with ruby-mode to
-automatically close blocks by inserting **end** when typing a
-block-keyword, followed by a space.
+## Installation
+I recommend installing via ELPA, but manual installation is simple as well:
-See comments in **ruby-end.el** for installation and usage information.
+ (add-to-list 'load-path "/path/to/ruby-end")
+ (require 'ruby-end)
+
+## Usage
+Start `ruby-end-mode` using.
+
+ (ruby-end-mode t)
+
+or
+
+ M-x ruby-end-mode
+
+Now try writing a block keyword, such as `class` or `def` and then `SPACE`.
+
+For more information, see comments in `ruby-end.el`.
+
+## Contribution
+Contribution is much welcome! Ruby end is tested using
[Ecukes](http://ecukes.info). When
+Adding new features, please write tests for them!
+
+To fetch Ecukes:
+
+ $ cd /path/to/ruby-end
+ $ git submodule init
+ $ git submodule update
+
+Run the tests with:
+
+ $ ./util/ecukes/ecukes features
