From 786093a8ad3c2c7f226cee60d326df74f51f8c15 Mon Sep 17 00:00:00 2001 From: Hackerpilot Date: Mon, 20 Apr 2015 10:27:41 -0700 Subject: [PATCH] Update documentation --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index cd4a91e..989306d 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,14 @@ when using the **--inplace** option. By default, dfmt reads its input from **stdin** and writes to **stdout**. If a file name is specified on the command line, input will be read from the file instead, and output will be written to **stdout**. + +**dfmt** uses EditorConfig files for configuration. If you run **dfmt** on a +source file it will look for .editorconfig files that apply to that source file. +If no file is specified on the command line, **dfmt** will look for .editorconfig +files that would apply to a D file in the current working directory. Command +line options can be used instead of .editorconfig files, or to override options +found in .editorconfig files. + ### Options * **--help**: Display command line options * **--inplace**: A file name is required and the file will be edited in-place.