branch: elpa/guru-mode
commit 12d55acb4d67cd39e9650e1b53dadb53b678e2d5
Author: Bozhidar Batsov <bozhi...@batsov.com>
Commit: Bozhidar Batsov <bozhi...@batsov.com>
Update master
---
README.md | 39 ++++++++++++++++++++++++++++++++++++---
1 file changed, 36 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index eccfb5e..822c7e2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,37 @@
-gosu-mode
-=========
+# Synopsis
-Learn to use Emacs the way it was meant to be used (the gosu way)
\ No newline at end of file
+Guru mode disables some common keybindings and suggests the use of the
established Emacs alternatives instead.
+
+# Installation
+
+## Manual
+Just drop `guru-mode.el` somewhere in your `load-path`. I favour the
+folder `~/.emacs.d/vendor`:
+
+```
+(add-to-list 'load-path "~/emacs.d/vendor")
+```
+
+You can enable projectile globally like this:
+
+```
+(require 'guru-mode)
+(guru-mode) ;; to enable in all buffers
+```
+
+## Marmalade
+
+If you're an Emacs 24 user or you have a recent version of package.el
+you can install guru-mode from the [Marmalade](http://marmalade-repo.org/)
repository.
+
+## MELPA
+
+If you're an Emacs 24 user or you have a recent version of package.el
+you can install guru-mode from the [MELPA](http://melpa.milkbox.net/)
repository.
+
+## Emacs Prelude
+
+guru-mode is naturally part of the
+[Emacs Prelude](https://github.com/bbatsov/prelude). If you're a Prelude
+user - guru-mode is already properly configured and ready for
+action.
\ No newline at end of file
