Merge pull request #3265 from mikerite/fix-export

[rust.git] / README.md

diff --git a/README.md b/README.md
index 3d994b4ef855d8e481b3e583b4f0a01a50e1ce0d..9dd41f6513c25882c9b42570c725ea3d9471ada9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,11 +5,11 @@ We are currently in the process of discussing Clippy 1.0 via the RFC process in
 [![Build Status](https://travis-ci.org/rust-lang-nursery/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/rust-clippy)
 [![Windows Build status](https://ci.appveyor.com/api/projects/status/id677xpw1dguo7iw?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/rust-clippy)
 [![Current Version](https://meritbadge.herokuapp.com/clippy)](https://crates.io/crates/clippy)
-[![License: MPL-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)
+[![License: MIT/Apache-2.0](https://img.shields.io/crates/l/clippy.svg)](#license)
 
 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
 
-[There are 276 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
+[There are 279 lints included in this crate!](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
 
 We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
 
@@ -64,6 +64,8 @@ rustup component add clippy-preview
 
 Now you can run Clippy by invoking `cargo clippy`.
 
+If it says that it can't find the `clippy` subcommand, please run `rustup self update`
+
 ### Running Clippy from the command line without installing it
 
 To have cargo compile your crate with Clippy without Clippy installation
@@ -81,18 +83,20 @@ Be sure that Clippy was compiled with the same version of rustc that cargo invok
 You can add Clippy to Travis CI in the same way you use it locally:
 
 ```yml
-- rust: stable
-- rust: beta
-  before_script:
-    - rustup component add clippy-preview
-  script:
-    - cargo clippy
-# if you want the build job to fail when encountering warnings, use
-    - cargo clippy -- -D warnings
-# in order to also check tests and none-default crate features, use
-    - cargo clippy --all-targets --all-features -- -D warnings
-    - cargo test
-    # etc.
+language: rust
+rust:
+  - stable
+  - beta
+before_script:
+  - rustup component add clippy-preview
+script:
+  - cargo clippy
+  # if you want the build job to fail when encountering warnings, use
+  - cargo clippy -- -D warnings
+  # in order to also check tests and none-default crate features, use
+  - cargo clippy --all-targets --all-features -- -D warnings
+  - cargo test
+  # etc.
 ```
 
 ## Configuration
@@ -141,7 +145,14 @@ enable/disable Clippy lints until `tool_lints` are stable:
 #![cfg_attr(feature = "cargo-clippy", allow(clippy_lint))]
 ```
 
+If you do not want to include your lint levels in your code, you can globally enable/disable lints by passing extra flags to clippy during the run: `cargo clippy -- -A lint_name` will run clippy with `lint_name` disabled and `cargo clippy -- -W lint_name` will run it with that enabled. On newer compilers you may need to use `clippy::lint_name` instead.
+
 ## License
 
-Licensed under [MPL](https://www.mozilla.org/MPL/2.0/).
-If you're having issues with the license, let me know and I'll try to change it to something more permissive.
+Copyright 2014-2018 The Rust Project Developers
+
+Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+<LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+option. All files in the project carrying such notice may not be
+copied, modified, or distributed except according to those terms.