]> git.lizzy.rs Git - rust.git/blobdiff - README.md
Tidy up and pass tests
[rust.git] / README.md
index e2da86c35307795dcd1dfad18528de0a9e28b892..5e4e1da9204bcd5c36ca63915469da18f8aef2de 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,46 +26,26 @@ the "travis example" badge above.
 
 ## Quick start
 
-Currently, you can use `rustfmt` on nightly and beta. Rust 1.24 stable will work,
-but we're not quite there yet!
+You can use `rustfmt` on Rust 1.24 and above.
 
 To install:
 
 ```
-rustup component add rustfmt-preview --toolchain=nightly
+rustup component add rustfmt-preview
 ```
 
-If `nightly` is your default toolchain, you can leave the `--toolchain` off.
-
 to run on a cargo project in the current working directory:
 
 ```
-cargo +nightly fmt
+cargo fmt
 ```
 
-If `nightly` is your default toolchain, you can leave off the `+nightly`.
-
 ## Installation
 
 ```
-rustup component add rustfmt-preview --toolchain=nightly
-```
-
-If you don't have a nightly toolchain, you can add it using rustup:
-
-```
-rustup install nightly
+rustup component add rustfmt-preview
 ```
 
-You can make the nightly toolchain the default by running:
-
-```
-rustup default nightly
-```
-
-If you choose not to do that you'll have to run rustfmt using `rustup run ...`
-or by adding `+nightly` to the cargo invocation.
-
 ## Installing from source
 
 To install from source, first checkout to the tag or branch you want to install, then issue
@@ -148,16 +128,14 @@ when a pull request contains unformatted code. Using `--write-mode=diff` instruc
 rustfmt to exit with an error code if the input is not formatted correctly.
 It will also print any found differences.
 
-A minimal Travis setup could look like this:
+A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust
 before_script:
-- rustup toolchain install nightly
-- rustup component add --toolchain nightly rustfmt-preview
-- which rustfmt || cargo install --force rustfmt-nightly
+- rustup component add rustfmt-preview
 script:
-- cargo +nightly fmt --all -- --write-mode=diff
+- cargo fmt --all -- --write-mode=diff
 - cargo build
 - cargo test
 ```