emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/ws-butler ea94b9895a 57/64: Add subsection on basic config


From: Stefan Kangas
Subject: [nongnu] elpa/ws-butler ea94b9895a 57/64: Add subsection on basic config in README.md
Date: Fri, 31 Dec 2021 11:09:35 -0500 (EST)

branch: elpa/ws-butler
commit ea94b9895a3c68c9877a0f4d6f9cf80ebf56d467
Author: alevy03 <alevy03@gmail.com>
Commit: GitHub <noreply@github.com>

    Add subsection on basic config in README.md
    
    Make it obvious, for new users, what minimal steps you need to start using 
ws-butler.
    Adapts and expands (a little) on the installation notes given at the top of 
ws-butler.el.
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 0cf39062ca..98a73aed28 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,17 @@ There might be lines you don't want to get trimmed, e.g. 
spaces in multiline str
 
 `apt-get install elpa-ws-butler`
 
+### Configuration
+
+To use ws-butler, require it and add ws-butler-mode as a hook on any mode
+where you would like it to be enabled. For example, to enable for all 
+ruby-mode buffers, add this to your .emacs:
+
+    (require 'ws-butler)
+    (add-hook 'ruby-mode-hook #'ws-butler-mode)
+
+Alternatively, you can use ws-butler-global-mode to turn it on everywhere.
+
 ## History
 
 1. I started by trimming all spaces at EOL in source code in a



reply via email to

[Prev in Thread] Current Thread [Next in Thread]