branch: elpa/crux
commit db47b78119775a644bdce46dd6796b9ef44da4b3
Author: Bozhidar Batsov <bozhi...@batsov.com>
Commit: Bozhidar Batsov <bozhi...@batsov.com>
Don't promote the default keybindings
---
README.md | 53 +++++++++++++++++++++++------------------------------
1 file changed, 23 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index d64dc89..a7a141e 100644
--- a/README.md
+++ b/README.md
@@ -33,40 +33,33 @@ If the installation doesn't work try refreshing the package
list:
<kbd>M-x package-refresh-contents</kbd>
-Add the following to your Emacs config to enable
-`crux`:
-
-```el
-(crux-setup-default-keybindings)
-```
-
## Keybindings
-Here's the list of the default keybindings. Feel free to bind
+crux doesn't setup any keybindings for its commands out-of-the-box.
+
+Here's the list of some suggested keybindings. Feel free to bind
individual commands to whatever keybindings you prefer.
-Keybinding | Description
--------------------|------------------------------------------------------------
-<kbd>C-c o</kbd> | Open the currently visited file with an external program.
-<kbd>C-S-RET</kbd> or <kbd>Super-o</kbd> | Insert an empty line above the
current line and indent it properly.
-<kbd>S-RET</kbd> or <kbd>M-o</kbd> | Insert an empty line and indent it
properly (as in most IDEs).
-<kbd>C-c n</kbd> | Fix indentation in buffer and strip whitespace.
-<kbd>C-c f</kbd> | Open recently visited file.
-<kbd>C-M-\\</kbd> | Indent region (if selected) or the entire buffer.
-<kbd>C-c u</kbd> | Open a new buffer containing the contents of URL.
-<kbd>C-c e</kbd> | Eval a bit of Emacs Lisp code and replace it with its
result.
-<kbd>C-c s</kbd> | Swap two active windows.
-<kbd>C-c D</kbd> | Delete current file and buffer.
-<kbd>C-c r</kbd> | Rename the current buffer and its visiting file if any.
-<kbd>C-c t</kbd> | Open a terminal emulator (`ansi-term`).
-<kbd>C-c k</kbd> | Kill all open buffers except the one you're currently in.
-<kbd>C-c TAB</kbd> | Indent and copy region to clipboard
-<kbd>C-c I</kbd> | Open user's init file.
-<kbd>C-c S</kbd> | Open shell's init file.
-<kbd>Super-r</kbd> | Recent files
-<kbd>Super-j</kbd> | Join lines
-<kbd>Super-k</kbd> | Kill whole line
-<kbd>C-Backspace</kbd> | Kill line backwards
+Command | Suggested Keybinding(s)
| Description
+--------------------------------------------|---------------------------------|------------------------
+`crux-open-with` | <kbd>C-c o</kbd> | Open the
currently visited file with an external program.
+`crux-smart-open-line-above` | <kbd>C-S-RET</kbd> or
<kbd>Super-o</kbd> | Insert an empty line above the current line and indent it
properly.
+`crux-smart-open-line` | <kbd>S-RET</kbd> or
<kbd>M-o</kbd> | Insert an empty line and indent it properly (as in most IDEs).
+`crux-cleanup-buffer-or-region` | <kbd>C-c n</kbd> | Fix
indentation in buffer and strip whitespace.
+`crux-recentf-ido-find-file` | <kbd>C-c f</kbd> or
<kbd>Super-r</kbd> | Open recently visited file.
+`crux-view-url` | <kbd>C-c u</kbd> | Open a new
buffer containing the contents of URL.
+`crux-eval-and-replace` | <kbd>C-c e</kbd> | Eval a bit of
Emacs Lisp code and replace it with its result.
+`crux-swap-windows` | <kbd>C-c s</kbd> | Swap two
active windows.
+`crux-delete-file-and-buffer` | <kbd>C-c D</kbd> | Delete
current file and buffer.
+`crux-rename-file-and-buffer` | <kbd>C-c r</kbd> | Rename the
current buffer and its visiting file if any.
+`crux-visit-term-buffer` | <kbd>C-c t</kbd> | Open a
terminal emulator (`ansi-term`).
+`crux-kill-other-buffers` | <kbd>C-c k</kbd> | Kill all open
buffers except the one you're currently in.
+`crux-indent-rigidly-and-copy-to-clipboard` | <kbd>C-c TAB</kbd> | Indent and
copy region to clipboard
+`crux-find-user-init-file` | <kbd>C-c I</kbd> | Open user's
init file.
+`crux-find-shell-init-file` | <kbd>C-c S</kbd> | Open shell's
init file.
+`crux-top-join-lines` | <kbd>Super-j</kbd> or
<kbd>C-^</kbd> | Join lines
+`crux-kill-whole-line` | <kbd>Super-k</kbd> | Kill whole
line
+`crux-kill-line-backwards` | <kbd>C-Backspace</kbd> | Kill
line backwards
## License
