Add Black compatible configurations in documentation (#1366 & #1205) (#1371)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 5a9d6ea686e3fd293740924a7a02ce703ef2a1a9..43d47fc6dfabbaa10170ecaaf84f524d6031eb5a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -127,6 +127,16 @@ _Black_ is a well-behaved Unix-style command-line tool:
 - it only outputs messages to users on standard error;
 - exits with code 0 unless an internal error occurred (or `--check` was used).
 
+### Using _Black_ with other tools
+
+While _Black_ enforces formatting that conforms to PEP 8, other tools may raise warnings
+about _Black_'s changes or will overwrite _Black_'s changes. A good example of this is
+[isort](https://pypi.org/p/isort). Since _Black_ is barely configurable, these tools
+should be configured to neither warn about nor overwrite _Black_'s changes.
+
+Actual details on _Black_ compatible configurations for various tools can be found in
+[compatible_configs](./docs/compatible_configs.md).
+
 ### NOTE: This is a beta product
 
 _Black_ is already [successfully used](#used-by) by many projects, small and big. It