[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 2a367fa 03/27: README.md: update doc
From: |
Oleh Krehel |
Subject: |
[elpa] master 2a367fa 03/27: README.md: update doc |
Date: |
Sat, 24 Jan 2015 20:36:29 +0000 |
branch: master
commit 2a367faac4f099965ae289efc9b8a8c8236310ec
Author: Oleh Krehel <address@hidden>
Commit: Oleh Krehel <address@hidden>
README.md: update doc
---
README.md | 22 +++++++++++++---------
1 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index bb153d7..3e76618 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,20 @@
-This package for GNU Emacs that can be used to tie related commands
-into a family of short bindings with a common prefix - a Hydra.
+This is a package for GNU Emacs that can be used to tie related
+commands into a family of short bindings with a common prefix - a
+Hydra.
-Once you summon a Hydra (through the prefixed binding), all the heads
-can be called in succession with only a short extension. The Hydra is
-vanquished once Hercules, any binding that isn't the Hydra's head,
-arrives. Note that Hercules, besides vanquishing the Hydra, will
-still serve his orignal purpose, calling his proper command. This
-makes the Hydra very seamless, it's like a minor mode that disables
-itself auto-magically.
+Once you summon the Hydra through the prefixed binding (the body + any
+one head), all heads can be called in succession with only a short
+extension.
+
+The Hydra is vanquished once Hercules, any binding that isn't the
+Hydra's head, arrives. Note that Hercules, besides vanquishing the
+Hydra, will still serve his orignal purpose, calling his proper
+command. This makes the Hydra very seamless, it's like a minor mode
+that disables itself auto-magically.
Here's how I use the examples bundled with Hydra:
+ (require 'hydra-examples)
(hydra-create "C-M-w" hydra-example-move-window-splitter)
You can expand the examples in-place, it still looks elegant:
- [elpa] master updated (c7f675e -> 7b78b37), Oleh Krehel, 2015/01/24
- [elpa] master 916a130 05/27: Depend on cl-lib v0.5 for `cl-mapcar', Oleh Krehel, 2015/01/24
- [elpa] master a179f31 04/27: Unbind hydra's body unconditionally to avoid error, Oleh Krehel, 2015/01/24
- [elpa] master abef4bf 02/27: Split away the examples, Oleh Krehel, 2015/01/24
- [elpa] master 2a367fa 03/27: README.md: update doc,
Oleh Krehel <=
- [elpa] master f55c1ff 07/27: Add `hydra-is-helpful' custom var, Oleh Krehel, 2015/01/24
- [elpa] master 9b86656 01/27: Initial import, Oleh Krehel, 2015/01/24
- [elpa] master 6966e14 11/27: Fix the bugged `global-set-key' version, Oleh Krehel, 2015/01/24
- [elpa] master 11323ec 06/27: Allow to use minor-mode-maps and more, Oleh Krehel, 2015/01/24
- [elpa] master dbd77f0 09/27: Don't unbind hydra's body, unless using global-set-key, Oleh Krehel, 2015/01/24
- [elpa] master 998b533 10/27: Make sure `windmove-wrap-around' is nil during tests, Oleh Krehel, 2015/01/24
- [elpa] master 5318fc3 08/27: Update `hydra-create' format, Oleh Krehel, 2015/01/24
- [elpa] master e156bf2 12/27: Require cl at compile time, Oleh Krehel, 2015/01/24
- [elpa] master 69bb4a4 13/27: Fix `kbd' interpretting "<tab>" char-by-char, Oleh Krehel, 2015/01/24
- [elpa] master b982fe5 14/27: Allow to add one head that disables the Hydra, Oleh Krehel, 2015/01/24