Index: README.md |
diff --git a/README.md b/README.md |
index 05401ea23bd336ea60f231b91ea4d08cb5883d75..d7cd2035f99d3b5d81caf7a33becc5fd4106b492 100644 |
--- a/README.md |
+++ b/README.md |
@@ -7,9 +7,9 @@ It handles indentation, inline whitespace and (by far the most difficult), |
intelligent line wrapping. It has no problems with nested collections, function |
expressions, long argument lists, or otherwise tricky code. |
-**The formatter is at an alpha state right now. It does a good job on most code, |
-and I'd love to have you try it and report bugs, but it has known issues and its |
-output will change over time.** |
+**The formatter is at a beta state right now. It does a good job on most code, |
+and I'd love to have you try it and [report bugs][bugs], but its output may |
+change over time.** |
## Running it |
@@ -33,7 +33,7 @@ By default, it formats each file and just prints the resulting code to stdout. |
If you pass `-w`, it will instead overwrite your existing files with the |
formatted results. |
-You may pass an `--line-length` option to control the width of the page that it |
+You may pass a `--line-length` option to control the width of the page that it |
wraps lines to fit within, but you're strongly encouraged to keep the default |
line length of 80 columns. |
@@ -48,29 +48,28 @@ API for formatting code. Simple usage looks like this: |
var formatter = new DartFormatter(); |
try { |
- formatter.format(""" |
+ print(formatter.format(""" |
library an_entire_compilation_unit; |
class SomeClass {} |
- """); |
+ """)); |
- formatter.formatStatement("aSingle(statement);"); |
+ print(formatter.formatStatement("aSingle(statement);")); |
} on FormatterException catch (ex) { |
print(ex); |
} |
} |
-[dart style guide]: https://www.dartlang.org/articles/style-guide/ |
-[globally activate]: https://www.dartlang.org/tools/pub/cmd/pub-global.html |
- |
## Stability |
You can rely on the formatter to not break your code or change its semantics. |
If it does do so, this is a critical bug and we'll fix it quickly. |
-The heuristics the formatter uses to determine the "best" way to split a line |
-are still being developed and may change over time. The ones today cover most |
-common uses, but there's room for more refinement. We don't promise that code |
-produced by the formatter today will be identical to the same code run through |
-a later version of the formatter. We do hope that you'll like the output of the |
-later version more. |
+The rules the formatter uses to determine the "best" way to split a line may |
+change over time. We don't promise that code produced by the formatter today |
+will be identical to the same code run through a later version of the formatter. |
+We do hope that you'll like the output of the later version more. |
+ |
+[bugs]: https://github.com/dart-lang/dart_style/issues |
+[dart style guide]: https://www.dartlang.org/articles/style-guide/ |
+[globally activate]: https://www.dartlang.org/tools/pub/cmd/pub-global.html |