branch: elpa/boxquote
commit 55c120adbd74882e87b731aa9f73095f9f48ee80
Author: Dave Pearson <da...@davep.org>
Commit: Dave Pearson <da...@davep.org>
Add README
---
README.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..b4ee8a1ec7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+## Commentary:
+
+boxquote provides a set of functions for using a text quoting style that
+partially boxes in the left hand side of an area of text, such a marking
+style might be used to show externally included text or example code.
+
+```
+,----
+| The default style looks like this.
+`----
+```
+
+A number of functions are provided for quoting a region, a buffer, a
+paragraph and a defun. There are also functions for quoting text while
+pulling it in, either by inserting the contents of another file or by
+yanking text into the current buffer.
+
+The latest version of `boxquote.el` can be found at:
+
+```
+ <URL:https://github.com/davep/boxquote.el>
+```
+
+## Thanks:
+
+Kai Grossjohann for inspiring the idea of boxquote. I wrote this code to
+mimic the "inclusion quoting" style in his Usenet posts. I could have
+hassled him for his code but it was far more fun to write it myself.
+
+Mark Milhollan for providing a patch that helped me get the help quoting
+functions working with XEmacs.
+
+Oliver Much for suggesting the idea of having a `boxquote-kill-ring-save`
+function.
+
+Reiner Steib for suggesting `boxquote-where-is` and the idea of letting
+`boxquote-describe-key` describe key bindings from other buffers. Also
+thanks go to Reiner for suggesting `boxquote-insert-buffer`.
