[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
- [nongnu] elpa/ws-butler 631db62b31 40/64: README.md typo., (continued)
- [nongnu] elpa/ws-butler 631db62b31 40/64: README.md typo., Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 0fbba548ff 38/64: Bump to 0.3, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 88b4570b31 15/64: add autoload cookies and global minor-mode, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler c906d77aee 10/64: provide feature #1, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler ec4172bb7a 22/64: Add debug declaration to macro., Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler e80d0df3e3 20/64: ignore PGP sig error in travis setting, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 404e70e75a 43/64: Tabify indentation for non-nil indent-tabs-mode, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 0c48a1d102 47/64: Merge pull request #17 from ilohmar/indent-tabs-symmetry, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 123a517a14 49/64: bump version to 0.4, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler e3a38d93e0 64/64: Merge pull request #37 from lewang/revert-31-patch-1, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler ea94b9895a 57/64: Add subsection on basic config in README.md,
Stefan Kangas <=
- [nongnu] elpa/ws-butler 2d546097bb 62/64: Use cl-lib, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 80dabd5d15 56/64: README tweak, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 84b3666af3 04/64: fix revert-hook typo, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 24cd7721f8 21/64: widen before doing work, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 246e5655ab 23/64: Fix never removing blank lines from EOF., Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler de5d1569bf 26/64: Clear buffer-modified-p only when necessary., Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler d265cef1ef 12/64: rename function, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler d62694365c 34/64: Merge pull request #11 from chris-martin/readme-cleanup, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler b59e36b245 53/64: bump version to 0.5, Stefan Kangas, 2021/12/31
- [nongnu] elpa/ws-butler 7d57ac7cf6 42/64: Added `ws-butler-trim-predicate' custom variable, Stefan Kangas, 2021/12/31