branch: elpa/rainbow-delimiters
commit c1149daac00f2b660b788452a506aefe391b771c
Author: Fanael Linithien <[email protected]>
Commit: Fanael Linithien <[email protected]>
Make it clear that global-rainbow-delimiters-mode is no more
Fixes #13
---
README.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/README.md b/README.md
index 499826f6d4..3f1fb58ea9 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,14 @@ To start the mode automatically in most programming modes
(Emacs 24 and above):
(add-hook 'prog-mode-hook #'rainbow-delimiters-mode)
+### Global mode
+
+There's no `global-rainbow-delimiters-mode` anymore. It used to exist, but it
+was impossible to keep it from breaking some major modes. It's *strongly
+recommended* to use major mode hooks instead, as shown above. There's nothing
+stopping you from defining `global-rainbow-delimiters-mode` yourself, but if it
+breaks something, you're on your own.
+
## Customization
To customize various options, including the color theme:
