[nongnu] elpa/multiple-cursors 0d40ea1 003/434: Updated readme.

[ELPA Syncer]

branch: elpa/multiple-cursors
commit 0d40ea161113790a1fbfd0eceeef63105fe3e242
Author: Magnar Sveen <magnars@gmail.com>
Commit: Magnar Sveen <magnars@gmail.com>

    Updated readme.
---
 README.org          | 47 +++++++++++++++++++++++++++++++++++++++++++++
 multiple-cursors.el | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 102 insertions(+)

diff --git a/README.org b/README.org
index c169def..ccd20b9 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,50 @@
 * multiple-cursors.el
 
 An experiment in multiple cursors for emacs. Still very much in beta.
+
+The basic concept works, but there are definitely some kinks to work out.
+
+** Usage
+
+I've set up my key-bindings like so:
+
+    ;; Experimental multiple-cursors
+    (global-set-key (kbd "C-S-c C-S-c") 
'mc/add-multiple-cursors-to-region-lines)
+    (global-set-key (kbd "C-S-c C-e") 'mc/edit-ends-of-lines)
+    (global-set-key (kbd "C-S-c C-a") 'mc/edit-beginnings-of-lines)
+
+To get out of multiple-cursors-mode, press `C-g`.
+
+** Contribute
+
+There's plenty wrong with this implementation still. I'm actively trying things
+out, and also considering combining it with
+[mark-multiple.el](https://github.com/magnars/mark-multiple.el) to get a more
+comprehensive tool.
+
+Still, if you've got something to contribute, please do not hesitate to open
+an issue, and we can take a look together before you dive into the elisp. :-)
+
+You'll find the repo at:
+
+    https://github.com/magnars/multiple-cursors.el
+
+** License
+
+Copyright (C) 2011 Magnar Sveen
+
+Author: Magnar Sveen <magnars@gmail.com>
+Keywords: editing cursors
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/multiple-cursors.el b/multiple-cursors.el
index bbc0bce..a094303 100644
--- a/multiple-cursors.el
+++ b/multiple-cursors.el
@@ -1,3 +1,56 @@
+;;; multiple-cursors.el --- An experiment in multiple cursors for emacs.
+
+;; Copyright (C) 2011 Magnar Sveen
+
+;; Author: Magnar Sveen <magnars@gmail.com>
+;; Keywords: editing cursors
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; An experiment in multiple cursors for emacs. Still very much in beta.
+;;
+;; The basic concept works, but there are definitely some kinks to work out.
+
+;; ** Usage
+
+;; I've set up my key-bindings like so:
+;;
+;;     ;; Experimental multiple-cursors
+;;     (global-set-key (kbd "C-S-c C-S-c") 
'mc/add-multiple-cursors-to-region-lines)
+;;     (global-set-key (kbd "C-S-c C-e") 'mc/edit-ends-of-lines)
+;;     (global-set-key (kbd "C-S-c C-a") 'mc/edit-beginnings-of-lines)
+;;
+;; To get out of multiple-cursors-mode, press `C-g`.
+
+;; ** Contribute
+
+;; There's plenty wrong with this implementation still. I'm actively trying 
things
+;; out, and also considering combining it with
+;; [mark-multiple.el](https://github.com/magnars/mark-multiple.el) to get a 
more
+;; comprehensive tool.
+;;
+;; Still, if you've got something to contribute, please do not hesitate to open
+;; an issue, and we can take a look together before you dive into the elisp. 
:-)
+;;
+;; You'll find the repo at:
+;;
+;;     https://github.com/magnars/multiple-cursors.el
+
+;;; Code:
+
 (defface mc/cursor-face
   '((t (:inverse-video t)))
   "The face used for additional cursors"
@@ -121,3 +174,5 @@
   (beginning-of-line))
 
 (provide 'multiple-cursors)
+
+;;; multiple-cursors.el ends here