docs: warn about future breaking change

azz · Oct 15, 2017 · ede69bb · ede69bb
1 parent dcecba7
commit ede69bb
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,8 +33,11 @@ pretttier-tslint file.ts
 
 ## API
 
+
 ```js
 import format from "prettier-eslint";
 
 format("file.ts");
 ```
+
+Currently the `format` function will write to disk and not return anything. This behavior **will change** in a minor release before `1.0.0` is released.