summaryrefslogtreecommitdiff
path: root/readme.org
diff options
context:
space:
mode:
authorninrod <filipe.silva@gmail.com>2017-12-01 23:15:12 -0200
committerninrod <filipe.silva@gmail.com>2017-12-01 23:15:12 -0200
commitf6162a7b5a65a297c8ebb8a81ce6e1278f958bbc (patch)
treeb3c7d1275b6a94c998f4eb4fcc89758603bbdcd9 /readme.org
parent55c820083a5f28d5361baeb9cd7da92549e5b3f5 (diff)
closes #1121.0.1
Diffstat (limited to 'readme.org')
-rw-r--r--readme.org18
1 files changed, 12 insertions, 6 deletions
diff --git a/readme.org b/readme.org
index 9fe80e7..011ad14 100644
--- a/readme.org
+++ b/readme.org
@@ -8,17 +8,23 @@
[[https://user-images.githubusercontent.com/8352747/33156355-1a2477d8-cfe0-11e7-93e7-47cc33821e37.png][https://user-images.githubusercontent.com/8352747/33156355-1a2477d8-cfe0-11e7-93e7-47cc33821e37.png]]
This package emulates [[https://github.com/tpope/vim-surround][surround.vim]] by [[https://github.com/tpope][Tim Pope]]. The functionality is wrapped into a minor mode.
-To enable it globally, add the following lines to ~/.emacs:
+
+This package uses [[https://github.com/emacs-evil/evil][Evil]] as its vi layer.
+
+* Installation
+
+To enable it through [[https://github.com/jwiegley/use-package][use-package]], add the following lines to =~/.emacs= or =~/.emacs.d/init.el=:
#+BEGIN_SRC emacs-lisp
-(require 'evil-surround)
-(global-evil-surround-mode 1)
+ (use-package evil-surround
+ :ensure t
+ :config
+ (global-evil-surround-mode 1))
#+END_SRC
-Alternatively, you can enable =surround-mode= along a major mode by adding
-=turn-on-surround-mode= to the mode hook.
+Alternatively, can add the =evil-surround.el= file to your load-path and add =(require 'evil-surround)= to your init file.
-This package uses [[https://github.com/emacs-evil/evil][Evil]] as its vi layer.
+Also, Instead of enabling it globally, you can also enable =surround-mode= along a major mode by adding =turn-on-surround-mode= to the mode hook.
* Usage
** Add surrounding