path: root/README.md
diff options
Diffstat (limited to 'README.md')
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..251d7c0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+This plugin provides a user command to be run on a buffer after filetype
+detection, applying some simple heuristics to adjust indentation settings if
+the user's settings don't appear to match the buffer's settings. It pivots on
+the value of `'expandtab'`.
+If changing from `'noexpandtab'` to `'expandtab'`, a guess at an appropriate
+value for `'shiftround'` is attempted. It may not be accurate.
+Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself.
+See `:help license`.
+[1]: https://sanctum.geek.nz/