[elpa] externals/m-buffer 25995a676e 009/115: README added.

[ELPA Syncer]

branch: externals/m-buffer
commit 25995a676ecdbda19eca1ef9463d5bc75a128a51
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Commit: Phillip Lord <phillip.lord@newcastle.ac.uk>

    README added.
---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..94672b6978
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+m-buffer.el
+===========
+[![Build 
Status](https://travis-ci.org/phillord/m-buffer.png?branch=master)](https://travis-ci.org/phillord/m-buffer)
+
+## Introduction
+
+This package provides a set of list-orientated functions for operating over
+the contents of Emacs buffers. Functions are generally purish: i.e. they may
+change the state of one buffer by side-effect, but should not affect point,
+current buffer, match data or so forth. Generally, markers are preferred over
+point locations so that it is possible, for example, to search for regexp
+matches and then replace them all without the early replacement invalidating
+the location of the later ones.
+
+For full commentary, please see [m-buffer.el](m-buffer.el).
+
+## Status
+
+Early release, all APIs subject to change.
+
+## Contributions
+
+Contributions are welcome. However, I would like to keep the option of hosting
+m-buffer.el on ELPA, therefore, contributors should have
+[Copyright Assignment 
papers](https://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html)
+with the FSF.
+
+
+## Change Log
+
+### 0.2
+
+#### New Functions
+ - Functions for matching block things -- line start and end, sentence end,
+   paragraph separators, words.
+ - `m-buffer-match-string` and `m-buffer-match-substring` for extracting
+   match-strings. 
+ 
+
+#### Name changes
+ - Functions now use singular rather than plural -- so `m-buffer-matches-data`
+   has become `m-buffer-match-data`.
+
+#### Matchers
+ - Regexp functions are now overloaded and take either a buffer and regexp or
+   match-data (except for `m-buffer-match-data` for which it makes no sense to
+   pass in match-data). This allows easy chaining of methods.
+ - Matchers now also overloaded for windows -- searching in the visible
+   portion of window. `m-buffer-match-data-visible-window` access this feature
+   directly.
+ - Have regularised names of arguments.
+
+#### Build and Test
+ - Reworked tests and build scripts.