Merge pull request #2303 from topecongiro/issue-2296

[rust.git] / README.md

diff --git a/README.md b/README.md
index 2041a50807453f5da6008313fc4aa2bd34f3a5b6..6604725ba76cf6d7430cadf0731a4002c3b4a43e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rustfmt?svg=true)](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly)
+# rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rustfmt?svg=true)](https://ci.appveyor.com/project/nrc/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly)
 
 A tool for formatting Rust code according to style guidelines.
 
@@ -162,7 +162,7 @@ language: rust
 cache: cargo
 before_script:
 - export PATH="$PATH:$HOME/.cargo/bin"
-- which rustfmt || cargo install rustfmt
+- which rustfmt || cargo install rustfmt-nightly
 script:
 - cargo fmt -- --write-mode=diff
 - cargo build
@@ -190,12 +190,12 @@ directory and it will apply the options in that file. See `rustfmt
 visual style previews, [Configurations.md](Configurations.md).
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
-guide]. For details that have not yet been formalized through the [style RFC
-process][fmt rfcs], we try to adhere to a style similar to that used in the
-[Rust repo][rust].
+guide] that has been formalized through the [style RFC
+process][fmt rfcs].
 
-If there are styling choices you don't agree with, we are usually happy to add
-options covering different styles. File an issue, or even better, submit a PR.
+Configuration options are either stable or unstable. Stable options can always
+be used, while unstable ones are only available on a nightly toolchain, and opt-in.
+See [Configurations.md](Configurations.md) for details.
 
 
 ## Tips