Skip to content

Commit

Permalink
Merge pull request #79 from kbknapp/docs-how-it-works
Browse files Browse the repository at this point in the history
docs: briefly explains how `cargo-outdated` works
  • Loading branch information
Frederick888 authored Oct 6, 2017
2 parents 2ab6ccf + 8c35c61 commit fd0de84
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ A cargo subcommand for displaying when Rust dependencies are out of date

`cargo-outdated` is for displaying when dependencies have newer versions available.

## How it works

The functionality of `cargo-outdated` largely depends on the `cargo` builtin command `cargo update`.

To retrieve the list of available SemVer compatible dependencies, `cargo-outdated` firstly creates a temporary workspace, then executes `cargo update` against it, finally compares the temporary dependency tree with the original one.

Similarly, to check the latest dependencies, `cargo-outdated` replaces the SemVer requirements of *direct* dependencies with wildcards then goes through the same process.

## Demo

Once installed (see below) running `cargo outdated` in a project directory looks like the following:
Expand Down

0 comments on commit fd0de84

Please sign in to comment.