summaryrefslogtreecommitdiff
path: root/readme.org
diff options
context:
space:
mode:
authorJames Nguyen <james@jojojames.com>2018-01-10 18:20:50 -0800
committerJames Nguyen <james@jojojames.com>2018-01-10 18:20:50 -0800
commit8768cf69cc878ec93d837ad0b9fe465c996718f7 (patch)
tree66c0c4b68dcf92f95d9c7905eb4ca8f9db9d4330 /readme.org
parent5b533eaf9dd9f080e05066e444d4574e9bf2e6e1 (diff)
Add section for configuration
Diffstat (limited to 'readme.org')
-rw-r--r--readme.org12
1 files changed, 12 insertions, 0 deletions
diff --git a/readme.org b/readme.org
index c777ab7..545912e 100644
--- a/readme.org
+++ b/readme.org
@@ -89,6 +89,18 @@ Here's another full TLDR ~use-package~ example.
(evil-collection-init))
#+end_src
+
+** Configuration
+
+ Modify ~evil-collection-mode-list~ to disable or add any modes that should be evilified by ~evil-collection~.
+
+ | Variable | Default | Description |
+ |--------------------------------------------+---------+-------------------------------------------------------------------|
+ | evil-collection-company-use-tng | t | Set up autocompletion to be similar to Vim's YouCompleteMe. |
+ | evil-collection-outline-bind-tab-p | t | Enable <tab>-based bindings in Outline mode. |
+ | evil-collection-term-sync-state-and-mode-p | t | Synchronize insert/normal state with char/line-mode in term-mode. |
+ | evil-collection-setup-minibuffer | nil | Set up Vim style bindings in the minibuffer. |
+
** Guidelines
The following rules serve as guiding principles to define the set of standard