]> git.lizzy.rs Git - rust.git/blobdiff - README.md
Use builder pattern for ListFormatting
[rust.git] / README.md
index a1a0007662e8b5fb8f93614f9fc1c57df15da675..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 .
 ```