Skip to content
This repository has been archived by the owner on Nov 7, 2024. It is now read-only.

Commit

Permalink
Switch to cargo-rdme
Browse files Browse the repository at this point in the history
The cargo-readme crate does not work with workspaces:

webern/cargo-readme#81

The cargo-rdme project seems to handle workspaces with no problems.
  • Loading branch information
schneems committed Oct 28, 2024
1 parent c50cdc1 commit a2899fd
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions cache_diff/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
<!--
This readme is created with https://github.com/livioribeiro/cargo-readme
This readme is created with https://crates.io/crates/cargo-rdme
To update: edit `cargo_diff/src/lib.rs` then run:
```
$ cd cargo_diff
$ cargo readme > README.md
$ cargo rdme > README.md
```
-->

# cache_diff

<!-- cargo-rdme start -->

Generate clean, human readable diffs between two cache structs

### What
Expand All @@ -35,6 +36,18 @@ cache, but also report back to the user what changed.

Due to the CNB layer implementation, this struct is often called "metadata".

### Install

```shell
$ cargo add cache_diff
```

For ANSI colored output, add the `bullet_stream` feature:

```shell
$ cargo add cache_diff --features bullet_stream
```

### Derive usage

By default a `#[derive(CacheDiff)]` will generate a `diff` function that compares each field in the struct.
Expand Down Expand Up @@ -140,3 +153,5 @@ let diff = now.diff(&Metadata { version: NoDisplay("3.3.0".to_string())});

assert_eq!(diff.join(" "), "version (`custom 3.3.0` to `custom 3.4.0`)");
```

<!-- cargo-rdme end -->

0 comments on commit a2899fd

Please sign in to comment.