Use builder pattern for ListFormatting

[rust.git] / README.md

diff --git a/README.md b/README.md
index 051820010d3d3eaaff956da4ea179fc9fbb747e2..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 .
 ```
@@ -123,17 +130,21 @@ completed without error (whether or not changes were made).
 * [Atom](atom.md)
 * Visual Studio Code using [vscode-rust](https://github.com/editor-rs/vscode-rust), [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt) or [rls_vscode](https://github.com/jonathandturner/rls_vscode) through RLS.
 
+
 ## Checking style on a CI server
 
 To keep your code base consistently formatted, it can be helpful to fail the CI build
 when a pull request contains unformatted code. Using `--check` instructs
 rustfmt to exit with an error code if the input is not formatted correctly.
-It will also print any found differences.
+It will also print any found differences. (Older versions of Rustfmt don't
+support `--check`, use `--write-mode diff`).
 
 A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust
+rust:
+- nightly
 before_script:
 - rustup component add rustfmt-preview
 script:
@@ -142,6 +153,9 @@ script:
 - cargo test
 ```
 
+See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)
+for more info.
+
 ## How to build and test
 
 `cargo build` to build.
@@ -180,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
@@ -209,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