Use builder pattern for ListFormatting

[rust.git] / README.md

diff --git a/README.md b/README.md
index 53b7e2757add80db5c1b54242978d26f34f7d13b..b2cc0c12d467d70714aa8a9e1412a7b0452d2dc3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ the "travis example" badge above.
 
 ## Quick start
 
-You can use `rustfmt` on Rust 1.24 and above.
+You can run `rustfmt` with Rust 1.24 and above.
 
 To install:
 
@@ -50,6 +50,12 @@ To run:
 cargo +nightly fmt
 ```
 
+To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing:
+
+```toml
+edition = "Edition2018"
+```
+
 ## Limitations
 
 Rustfmt tries to work on as much Rust code as possible, sometimes, the code
@@ -88,6 +94,7 @@ rustup component add rustfmt-preview
 ## Installing from source
 
 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
+
 ```
 cargo install --path .
 ```
@@ -187,7 +194,7 @@ See [Configurations.md](Configurations.md) for details.
 * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
   target file directory or its parents to override the default settings of
   rustfmt. You can generate a file containing the default configuration with
-  `rustfmt --dump-default-config rustfmt.toml` and customize as needed.
+  `rustfmt --print-config default rustfmt.toml` and customize as needed.
 * After successful compilation, a `rustfmt` executable can be found in the
   target directory.
 * If you're having issues compiling Rustfmt (or compile errors when trying to
@@ -216,6 +223,23 @@ See [Configurations.md](Configurations.md) for details.
 
   (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
 
+* You can change the way rustfmt emits the changes with the --emit flag:
+
+  Example:
+
+  ```
+  cargo fmt --emit files
+  ```
+
+  Options:
+
+  | Flag |Description| Nightly Only |
+  |:---:|:---:|:---:|
+  | files | overwrites output to files | No |
+  | stdout | writes output to stdout | No | 
+  | coverage | displays how much of the input file was processed | Yes |
+  | checkstyle | emits in a checkstyle format | Yes |
+
 ## License
 
 Rustfmt is distributed under the terms of both the MIT license and the