aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormitermayer <mitermayer.reis@gmail.com>2017-05-24 16:25:51 -0700
committermitermayer <mitermayer.reis@gmail.com>2017-05-24 16:25:51 -0700
commit5077b05485e524f1e51fcb650984da4e728f1ba1 (patch)
treeb15c250e6b5c6fe00eb3fa974020de8de4b10a66
parentd60719ac3bf4ed1b10779406fd656e37c0bc42a3 (diff)
downloadvim-prettier-5077b05485e524f1e51fcb650984da4e728f1ba1.tar.xz
Making it clear that auto format is enable by default on files with
'@format' tag
-rw-r--r--README.md2
-rw-r--r--doc/prettier.txt3
2 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 71e53d0..7009685 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
A vim plugin wrapper for prettier, pre-configured with custom default prettier settings.
+By default it will auto format javascript files that have "@format" annotation in the header of the file.
+
### INSTALL
Install with [vim-plug](https://github.com/junegunn/vim-plug), assumes node and yarn|npm installed globally.
diff --git a/doc/prettier.txt b/doc/prettier.txt
index 8c9ed22..a2f17f1 100644
--- a/doc/prettier.txt
+++ b/doc/prettier.txt
@@ -13,6 +13,9 @@ INTRODUCTION *vim-prettier-introduction*
A vim plugin wrapper for prettier, pre-configured with
custom default prettier settings.
+By default it will auto format javascript files that have "@format"
+annotation in the header of the file.
+
When installed via vim-plug, a default prettier executable is installed inside
vim-prettier.