update doc

[spray] / Readme.org

diff --git a/Readme.org b/Readme.org
index 78d1894cb94e22041e4eaaa937489d7718122ca9..5e379c1f63301f59ea04a9cdd45b1fe3e745f904 100644 (file)
--- a/Readme.org
+++ b/Readme.org
@@ -1,7 +1,10 @@
 * spray.el
 
-A speed reading mode for Emacs (an elisp implementation of
-[[https://github.com/Miserlou/OpenSpritz][OpenSpritz]]).
+A speed reading mode for Emacs.
+
+The algorithm is taken from [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]] (with a few modifications).
+
+NOTE: This is a WIP project and thus APIs may change.
 
 ** Screencast
 
@@ -9,12 +12,37 @@ A speed reading mode for Emacs (an elisp implementation of
 
 ** Installation
 
-Put this script into a "load-path"ed directory, and load it in your
-init file.
+Put cedit.el into a "load-path"ed directory, and load it in your init
+file.
 
 : (require 'spray)
 
-Then you may run spray with "M-x spray-mode". Binding some keys may
-also be useful.
+Then you can start spraying from the cursor position with =M-x
+spray-mode=. Binding some keys may also be useful.
 
 : (global-set-key (kbd "<f6>") 'spray-mode)
+
+** Commands
+
+In spray-mode buffers, following commands are available.
+
+- =spray-start/stop= (SPC) ::
+     pause or resume spraying
+
+- =spray-backward-word= (h, <left>) ::
+     pause and back to the last word
+
+- =spray-forward-word= (l, <right>) ::
+     inverse of =spray-backward-word=
+
+Press any key else to quit =spray-mode=.
+
+** Customization
+
+You may customize spray by modifying following items:
+
+- [Variable] spray-wpm
+- [Variable] spray-height
+- [Keymap] spray-mode-map
+- [Face] spray-base-face
+- [Face] spray-orp-face