[nongnu] elpa/page-break-lines 965bc23670 03/80: Add a basic README

[ELPA Syncer]

branch: elpa/page-break-lines
commit 965bc236700428743ba980c77140025688ac1a2c
Author: Steve Purcell <steve@sanityinc.com>
Commit: Steve Purcell <steve@sanityinc.com>

    Add a basic README
---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..a666237ba1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+page-break-lines.el
+===================
+
+This Emacs library provides a global mode which displays ugly form feed
+characters as tidy horizontal rules.
+
+Installation
+=============
+
+If you choose not to use one of the convenient
+packages in [Melpa][melpa] and [Marmalade][marmalade], you'll need to
+add the directory containing `page-break-lines.el` to your `load-path`, and
+then `(require 'page-break-lines)`.
+
+Usage
+=====
+
+Enable `page-break-lines-mode` globally like this:
+
+     (turn-on-page-break-lines-mode)
+
+[marmalade]: http://marmalade-repo.org
+[melpa]: http://melpa.milkbox.net
+
+<hr>
+
+[![](http://api.coderwall.com/purcell/endorsecount.png)](http://coderwall.com/purcell)
+
+[![](http://www.linkedin.com/img/webpromo/btn_liprofile_blue_80x15.png)](http://uk.linkedin.com/in/stevepurcell)