branch: elpa/isl
commit ac8edb7c062e3047c8b67f28f29f90b3bfce75e6
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Update README
---
README.md | 2 --
README.org | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 58 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
deleted file mode 100644
index c014ae150dc..00000000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# isearch-light
-A simple Isearch replacement for Emacs.
diff --git a/README.org b/README.org
new file mode 100644
index 00000000000..6478d60f055
--- /dev/null
+++ b/README.org
@@ -0,0 +1,58 @@
+* isearch-light
+
+An Isearch replacement for Emacs.
+It aims to keep simple with only the needed features, no extra
+features you will never use.
+
+** install
+
+*** From source
+
+Add isearch-light.el to =load-path=.
+
+Then add =(require 'isearch-light)= in your init file.
+
+Even better, you can autoload it:
+
+#+begin_src elisp
+ (autoload 'isl "isearch-light" nil t)
+#+end_src
+
+With =use-package= and binding =C-s=
+
+#+begin_src elisp
+ (use-package isearch-light
+ :bind (("C-s" . isl)))
+#+end_src
+
+*** With [[https://github.com/raxod502/straight.el][Straight]]
+
+#+begin_src elisp
+ (use-package isearch-light
+ :straight (isearch-light :host github :repo
"thierryvolpiatto/isearch-light")
+ :bind (("C-s" . isl)))
+#+end_src
+
+** Usage
+
+M-x src
+
+The mode-line give you several infos, arrows up/down tell you the
+direction when you are actually moving, the ">" and "<" mean you are
+either below or above initial position in buffer. Regex or literal
+tell you the style of search you are using.
+
+Here the commands available:
+
+- C-s isl-goto-next
+- C-r isl-goto-prev
+- <down> isl-goto-next
+- <up> isl-goto-prev
+- RET isl-exit-at-point
+- C-w isl-yank-word-at-point
+- M-r isl-toggle-style-matching
+- M-< isl-goto-first
+- M-> isl-goto-last
+
+
+
