summary history branches tags files
commit:7b8263576ec0a879bba7fca0f42fc0d8094dd7e2
author:Trevor Bentley
committer:Trevor Bentley
date:Sun Apr 29 20:16:38 2018 +0200
parents:0ef274844d953fb81abfa5287e3859ea8cdcfc62
Added README
diff --git a/README.md b/README.md
line changes: +48/-0
index 0000000..e50ba32
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# emacs-maxibuffer (maxibuffer.el)
+
+## Description
+
+maxibuffer provides a way to request user input in a temporary buffer,
+similar to the temporary buffers used by org-capture, org-src-edit, and magit
+commit buffers.  Sometimes you want to ask the user for plenty of input, and
+let them write it in a real buffer with whichever modes they prefer, and get
+the results back asynchronously.  That's what maxibuffer is for.
+
+A maxibuffer can be spawned empty, or pre-filled with some text.
+
+Depending on how `maxibuffer-open` is called, when a maxibuffer is
+saved-and-closed (with `C-c C-c` by default) the contents of the buffer are
+either inserted at the point where the cursor was when the maxibuffer was
+spawned, or passed to a provided callback function.
+
+A maxibuffer can be killed without saving with `C-c C-k` by default.
+
+Key bindings can be changed or extended by customizing `maxibuffer-mode-map`.
+
+Examples:
+
+  `(maxibuffer-open)` -- Opens an empty maxibuffer.  When the buffer is
+     saved, the contents of the buffer are inserted at the point where the
+     cursor was when the maxibuffer was opened.
+
+  `(maxibuffer-open "His name is Robert Paulson." 'cb-fn)` -- Opens a
+     maxibuffer pre-populated with a string.  When it is saved, the `cb-fn`
+     function is called with the entire contents of the maxibuffer.
+
+As a text, you can execute this line then type `C-c C-c` in the spawned
+window.  You should see this message, with any modifications you made,
+printed in the echo area.
+
+(maxibuffer-open "This is a test" 'message)
+
+## Contributing
+
+Make a pull request, or send an e-mail.
+
+## Author
+
+Trevor Bentley (trevor@trevorbentley.com)
+
+## License
+
+GPLv3