branch: externals/shell-command+
commit ac4ec3cd9c52da65292ca97e4f65c9708c877a57
Author: Philip K <phi...@warpmail.net>
Commit: Philip K <phi...@warpmail.net>
added initial readme
---
README.md | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1e4d591
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+`bang.el`
+=========
+
+`bang` is a `shell-command` substitute that makes it easier to run
+commands on regions or whole buffers. This is done by potentially
+interpreting the first character differently, as the `bang` docstring
+explains:
+
+ When COMMAND starts with
+ < the output of COMMAND replaces the current selection
+ > COMMAND is run with the current selection as input
+ | the current selection is filtered through COMMAND
+ ! executes the last command that started with COMMAND,
+ or if a number, re-execute nth last command
+
+Bang has been based on a function of the same name by [Leah
+Neukirchen][leah].
+
+How to use
+----------
+
+Using MELPA and `use-package`, a minimal setup might look something like
+this:
+
+ (use-package bang
+ :bind ("M-!" . bang))
+
+Copying
+-------
+
+`bang.el` is distributed under the [CC0 1.0 Universal (CC0 1.0) Public
+Domain Dedication][cc0] license.
+
+[leah]: http://leahneukirchen.org/dotfiles/.emacs
+[cc0]: https://creativecommons.org/publicdomain/zero/1.0/deed
