deps.rs/README.md

# Deps.rs - Dependency status at a glance

[![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)

![A screenshot showing the deps.rs status of the libc crate](resources/banner.png)

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, Bitbucket, and SourceHut.
To analyze the state of your dependencies you can use the following URLs:

- for projects on crates.io: `https://deps.rs/crate/<NAME>`
- for projects on Github, Gitlab, Bitbucket, SourceHut, Codeberg, or Gitea: `https://deps.rs/repo/<HOSTER>/<USER>/<REPO>` (where `<HOSTER>` is either `github`, `gitlab`, `bitbucket`, `sourcehut`, `codeberg`, or `gitea/<DOMAIN>`)

## Badges

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!

Badges have a few style options, specified with query parameters, that match the styles from `shields.io`:
- `?style=flat` (default)
- `?style=flat-square`
- `?style=for-the-badge`

## 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

Copyright 2018 Sam Rijs and Contributors

Licensed under the Apache License, Version 2.0 (the "License").
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Update the project readme (#72) 2020-10-25 03:38:49 +00:00			`# Deps.rs - Dependency status at a glance`
add build status to readme 2018-01-27 10:31:23 +00:00
Update all the links in README to the new org 2020-09-29 19:25:46 +00:00			`[![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)`
change license to Apache 2.0 2018-02-11 07:14:42 +00:00
Update the project readme (#72) 2020-10-25 03:38:49 +00:00			`![A screenshot showing the deps.rs status of the libc crate](resources/banner.png)`
add maintainance note to readme 2019-11-10 10:02:12 +00:00
Update the project readme (#72) 2020-10-25 03:38:49 +00:00			`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.`

Mention SourceHut support in README.md (#120) This is an addendum to the now-merged PR #117 which actually implemented the support. 2021-09-02 09:35:56 +00:00			`We currently support projects and crates hosted on crates.io, Github, Gitlab, Bitbucket, and SourceHut.`
Update the project readme (#72) 2020-10-25 03:38:49 +00:00			`To analyze the state of your dependencies you can use the following URLs:`

Updated README.md (#81) Changed the url, as `https://deps.rs/crates/<name>` resolves to 404. 2020-11-26 14:28:55 +00:00			- for projects on crates.io: `https://deps.rs/crate/<NAME>`
Support for self-hosted Gitea (#164) deps.rs is now available for self-hosted Gitea at `/repo/gitea/<DOMAIN>/owner/repo`, e. g. `/repo/gitea/git.example.org/deps-rs/deps.rs`, `/repo/gitea/git.example.org:1234/deps-rs/deps.rs`, `/repo/gitea/http://unsafe-gitea.org/deps-rs/deps.rs`. This _should_ also include support for Gitea hosted in subdirectories, e. g. `www.example.org/gitea`, though I haven't tested this yet. If no protocol (`https://`/`http://`) is specified, `https://` is automatically added to the beginning of the gitea server's URL. However I could also change this to only accept https. Another option might be the use of URL-encoding. I am open for feedback, feel free to suggest changes. Implementation notes: - The Router now matches `/repo/*site/:qual/:name` instead of `/repo/:site/:qual/:name` to allow for an arbitrary number of `/`s before qual and name. - `RepoSite` now has a new variant `Gitea(GiteaDomain)`. - `RepoSite` no longer implements `Copy`. However this should not be problematic because `Copy`ing was only used for `to_base_uri`, `to_usercontent_base_uri` and `to_usercontent_repo_suffix` which now accept `&self` references. - `RepoSite` no longer implements `AsRef` and now uses `Display` instead. - updated test `correct_raw_url_generation` - updated readme Related to #84, #141 2022-08-21 09:16:52 +00:00			- for projects on Github, Gitlab, Bitbucket, SourceHut, Codeberg, or Gitea: `https://deps.rs/repo/<HOSTER>/<USER>/<REPO>` (where `<HOSTER>` is either `github`, `gitlab`, `bitbucket`, `sourcehut`, `codeberg`, or `gitea/<DOMAIN>`)
Update the project readme (#72) 2020-10-25 03:38:49 +00:00
Add for-the-badge style and docs (#139) 2022-01-29 14:12:01 +00:00			`## Badges`

Update the project readme (#72) 2020-10-25 03:38:49 +00:00			`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!`

Add for-the-badge style and docs (#139) 2022-01-29 14:12:01 +00:00			Badges have a few style options, specified with query parameters, that match the styles from `shields.io`:
			- `?style=flat` (default)
			- `?style=flat-square`
			- `?style=for-the-badge`

Update the project readme (#72) 2020-10-25 03:38:49 +00:00			`## 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.
add maintainance note to readme 2019-11-10 10:02:12 +00:00
improve license section in readme 2018-02-11 07:21:24 +00:00			`## Copyright and License`
change license to Apache 2.0 2018-02-11 07:14:42 +00:00
improve license section in readme 2018-02-11 07:21:24 +00:00			`Copyright 2018 Sam Rijs and Contributors`
change license to Apache 2.0 2018-02-11 07:14:42 +00:00
improve license section in readme 2018-02-11 07:21:24 +00:00			`Licensed under the Apache License, Version 2.0 (the "License").`
change license to Apache 2.0 2018-02-11 07:14:42 +00:00			`You may obtain a copy of the License at`

			`http://www.apache.org/licenses/LICENSE-2.0`

			`Unless required by applicable law or agreed to in writing, software`
			`distributed under the License is distributed on an "AS IS" BASIS,`
			`WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.`
			`See the License for the specific language governing permissions and`
			`limitations under the License.`