Update README (fix #26)

README.org

@@ -0,0 +1,70 @@
+* Beginend
+  #+BEGIN_HTML
+      <p>
+        <a href="https://travis-ci.org/DamienCassou/beginend">
+          <img src="https://travis-ci.org/DamienCassou/beginend.svg?branch=master" alt="Build Status" />
+        </a>
+        <a href='https://coveralls.io/github/DamienCassou/beginend?branch=master'>
+          <img src='https://coveralls.io/repos/github/DamienCassou/beginend/badge.svg?branch=master' alt='Coverage Status' />
+        </a>
+      </p>
+  #+END_HTML
+
+** Summary
+
+Redefine ~M-<~ and ~M->~ (or any keys bound to ~beginning-of-buffer~
+and ~end-of-buffer~) for some modes so that point moves to meaningful
+lines. The real beginning and end of buffers are still accessible by
+pressing the same key again.
+
+In particular, these modes are supported:
+
+- in *dired-mode*, ~M-<~ (respectively ~M->~) goes to the first (respectively
+  last) file, ignoring heading, ~.~ and ~..~;
+- in *message-mode*, ~M-<~ goes to the first line of the message body
+  (after headings) while ~M->~ goes to the last line before message
+  signature;
+- in *occur-mode*, ~M-<~ (respectively ~M->~) goes to the first
+  (respectively last) match;
+
+Other supported modes are ~ibuffer-mode~, ~vc-dir-mode~, ~bs-mode~,
+~recentf-dialog-mode~, ~org-agenda-mode~, ~compilation-mode~,
+~notmuch-search-mode~, ~elfeed-mode~, and ~prodigy-mode~.
+
+** Installing
+
+Use [[http://melpa.org/][melpa]].
+
+** Using
+
+You can activate beginend for all modes it supports by customizing the
+variable ~beginend-global-mode~ (~M-x customize-variable RET
+beginend-global-mode RET~) or by adding this line to your
+configuration file:
+
+#+BEGIN_SRC emacs-lisp
+(beginend-global-mode)
+#+END_SRC
+
+You can also decide to only activate beginend for some of its
+supported modes. Activate the dedicated beginend mode then (e.g.,
+~beginend-dired-mode~).
+
+At this point, newly opened supported buffers will get improved
+versions of ~M-<~ and ~M->~ (or any keys bound to
+~beginning-of-buffer~ and ~end-of-buffer~).
+
+** Examples
+Dired-mode:
+[[file:media/beginend-dired-mode.gif]]
+Message mode:
+[[file:media/beginend-message-mode.gif]]
+Occur mode:
+[[file:media/beginend-occur-mode.gif]]
+** Contributing
+
+Yes, please do! See [[file:CONTRIBUTING.md][CONTRIBUTING]] for guidelines.
+
+** License
+
+See [[file:COPYING][COPYING]]. Copyright (c) 2017 [[mailto:damien@cassou.me][Damien Cassou]] and [[mailto:matus.goljer@gmail.com][Matus Goljer]].