Merge branch 'master' of github.com:sonatype-nexus-community/cargo-pants

Author: gmohre

README.md

@@ -22,8 +22,98 @@ limitations under the License.
     <a href="https://crates.io/crates/cargo-pants"><img src="https://img.shields.io/crates/v/cargo-pants.svg"></img></a>
 </p>
 
-# cargo -pants
+# cargo pants
 
-`cargo pants` is a Cargo subcommand that provides a bill of materials in a project, and any vulnerabilities that are found on those dependencies, powered by [Sonatype OSS Index](https://ossindex.sonatype.org/).
+`cargo-pants` is a Cargo subcommand that provides a bill of materials in a project, and any vulnerabilities that are found on those dependencies, powered by [Sonatype OSS Index](https://ossindex.sonatype.org/).
+
+## Why pants?
+
+Don't you check your pants for holes? Similarly, we think you should check your app's dependencies for vulnerabilities, and that's what `cargo-pants` does! As well, we provide a Bill Of Materials from parsing your `Cargo.lock` file, so you can see all the dependencies you are using.
+
+## Requirements
+
+`cargo-pants` was built with Rust 1.31, you should likely start there.
+
+## Installation
+
+`cargo-pants` is a Cargo subcommand, and can be installed using `cargo install`:
+
+```
+$ cargo install cargo-pants
+```
+
+Once you have installed `cargo-pants`, you can run it like so:
+
+```
+$ cargo pants
+```
+
+## Usage
+
+`cargo pants` can be run in your builds context, or ran separately. Two command line flags are supported:
+
+```
+$ cargo pants --lock_file /path/to/Cargo.lock
+```
+
+This allows you to run `cargo pants` on a `Cargo.lock` file anywhere on your filesystem.
+
+If this flag is not supplied, `cargo pants` will assume a local `Cargo.lock` file.
+
+We will also inform you of our opinions of your pants style choice:
+
+```
+$ cargo pants --pants_style JNCO
+```
+
+We are very serious about pants.
+
+If vulnerabilities are found, `cargo-pants` exits with status code 3, and prints the Bill Of Materials/Found Vulnerabilities. If there are no issues, it will exit with status code 0.
+
+## CI Usage
+
+Similar to `cargo audit` but with more pants, you can run `cargo pants` on your builds using this example config:
+
+```
+language: rust
+before_script:
+  - cargo install --force cargo-pants
+script:
+  - cargo pants
+```
+
+## Contributing
+
+We care a lot about making the world a safer place, and that's why we created `cargo-pants`. If you as well want to
+speed up the pace of software development by working on this project, jump on in! Before you start work, create
+a new issue, or comment on an existing issue, to let others know you are!
+
+## Acknowledgements
+
+The code for `cargo-pants` was largely written by Glenn Mohre, and we want to give ultimate thanks, kudos, congratulations to Glenn for contributing this to the community. Open Source is awesome, and you help make it better!
+
+The `cargo-pants` logo was grabbed from [www.pexels.com](https://www.pexels.com), specifically from [this image](https://www.pexels.com/photo/people-wearing-denim-jeans-1353361/). 
+
+Code for `cargo-pants` was influenced by `cargo-audit`, and we acknowledge we stand on the shoulders of giants.
+
+## The Fine Print
+
+It is worth noting that this is **NOT SUPPORTED** by Sonatype, and is a contribution of ours
+to the open source community (read: you!)
+
+Remember:
+
+* Use this contribution at the risk tolerance that you have
+* Do NOT file Sonatype support tickets related to `cargo-pants` support in regard to this project
+* DO file issues here on GitHub, so that the community can pitch in
+
+Phew, that was easier than I thought. Last but not least of all:
+
+Have fun creating and using `cargo-pants` and the [Sonatype OSS Index](https://ossindex.sonatype.org/), we are glad to have you here!
+
+## Getting help
+
+Looking to contribute to our code but need some help? There's a few ways to get information:
+
+* Chat with us on [Gitter](https://gitter.im/sonatype/nexus-developers)
 
-### TBD - Add usage