diff --git a/README.md b/README.md index 964e290..4005630 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,39 @@ -# Deps.rs +# Deps.rs - Dependency status at a glance -[![Build Status](https://travis-ci.org/deps-rs/deps.rs.svg?branch=master)](https://travis-ci.org/deps-rs/deps.rs) [![dependency status](https://deps.rs/repo/github/deps-rs/deps.rs/status.svg)](https://deps.rs/repo/github/deps-rs/deps.rs) [![GitHub license](https://img.shields.io/github/license/deps-rs/deps.rs.svg)](https://github.com/deps-rs/deps.rs/blob/master/LICENSE) -## Call for maintainer(s) +![A screenshot showing the deps.rs status of the libc crate](resources/banner.png) -A group of volunteers has recently picked up maintainership for this project. If you are interested in contributing to `deps.rs`, please let us know by commenting under [this issue](https://github.com/deps-rs/deps.rs/issues/40). +Deps.rs is a service that shows you at a glance if any of your dependencies are out of date or insecure. +This works by comparing the dependencies in a project's `Cargo.toml` to the latest versions in the crates.io database. +For security-related information, we query the RustSec Security Advisory Database. + +We currently support projects and crates hosted on crates.io, Github, Gitlab and Bitbucket. +To analyze the state of your dependencies you can use the following URLs: + +- for projects on crates.io: `https://deps.rs/crates/` +- for projects on Github, Gitlab or Bitbucket: `https://deps.rs/repo///` (where `` is either `github`, `gitlab` or `bitbucket`) + +On the analysis page, you will also find the markdown code to include a fancy badge in your project README so visitors (and you) can see at a glance if your dependencies are still up to date! + +## Contributing + +We are always looking for help from the community! Feel like a feature is missing? Found a bug? [Open an issue](https://github.com/deps-rs/deps.rs/issues/new)! + +Do you want to contribute? Then browse the [list](https://github.com/deps-rs/deps.rs/issues) of open issues and ask if you can take care of it. + +## Building the project + +To get started on the project simply clone the repository and run the build: + +``` +git clone https://github.com/deps-rs/deps.rs +cd deps.rs +cargo run +``` + +The started development server will listen on port 8080 on localhost, so you just have to point your browser to `http://localhost:8080` to see if it works. ## Copyright and License diff --git a/resources/banner.png b/resources/banner.png new file mode 100644 index 0000000..ac66147 Binary files /dev/null and b/resources/banner.png differ