path: root/README.md
diff options
authorTom Ryder <tom@sanctum.geek.nz>2018-06-10 01:38:47 +1200
committerTom Ryder <tom@sanctum.geek.nz>2018-06-10 01:38:47 +1200
commitfb3c25becd1e4a565c4339b000b96ff519544dbd (patch)
tree3ad12db14bb965ee3560e6ee37da48fcf46f9699 /README.md
parentInitial commit (diff)
Refactor majorly for 0.2.0v0.2.0
- Do report counts of trimmed and deleted lines (and distinguish them accurately) - Fully backport to 6.0 (no cursor() func in that version) - Don't substitute on lines without trailing space
Diffstat (limited to 'README.md')
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f7d95c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+This plugin provides a mapping target and an optional custom command with the
+author's approach to stripping trailing whitespace from an entire buffer,
+including removing empty or whitespace-only lines at the end of the buffer,
+without making command noise and without moving the cursor from its current
+This is a very commonly written and implemented plugin, but I wrote my own
+because I could not find a plugin that did this in exactly the way I wanted:
+- Provide a `<Plug>` mapping
+- Provide a user command to do the stripping as well if wanted
+- Strip trailing lines as well as trailing spaces, reporting both
+- Work with even very old Vim (>=6.0)
+- Work with a single `undo`
+- Don't move the cursor
+- Don't change the search pattern
+- Don't define an `autocmd`
+- Don't force a key mapping
+- Don't define a global function
+Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself.
+See `:help license`.
+[1]: https://sanctum.geek.nz/