branch: externals/ruby-end
commit d00bb287d6dfb3042e35fa5d14a41949d608ff61
Author: Johan Andersson <[email protected]>
Commit: Johan Andersson <[email protected]>
Adding some docs.
---
README | 0
README.markdown | 6 ++++++
ruby-end.el | 12 ++++++++++++
3 files changed, 18 insertions(+)
diff --git a/README b/README
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000000..527bb7cbb1
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,6 @@
+# ruby-end
+
+ruby-end is a minor mode for Ruby that closes a block by inserting
+**end** when typing a block keyword, followed by a space.
+
+See comments in **ruby-end.el** for installation and usage information.
diff --git a/ruby-end.el b/ruby-end.el
index dd7adf373f..4e2c79bcdd 100644
--- a/ruby-end.el
+++ b/ruby-end.el
@@ -31,6 +31,18 @@
;;; Commentary:
+;; ruby-end is a minor mode for Ruby that closes a block by inserting
+;; "end" when typing a block keyword, followed by a space.
+;;
+;; To use ruby-end-mode, make sure that this file is in Emacs load-path:
+;; (add-to-list 'load-path "/path/to/directory/or/file")
+;;
+;; Then require ruby-end:
+;; (require 'ruby-end)
+;;
+;; ruby-end-mode start automatically when ruby-mode is activated.
+
+
;;; Code:
(defvar ruby-end-mode-map
