Skip to content

Commit

Permalink
docs: added new features to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
WyvernIXTL committed Sep 21, 2024
1 parent 4c4538d commit 71934b7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Afterwards it fetches the metadata of said packages with `cargo metadata`.
The `repository` field of the crates is used for fetching the license files.
Licenses from github are fetched directly via its api!
All licenses that aren't fetched via api are fetched with `git`.
Licenses that are fetched are cached between runs.
The data is then serialized and compressed.

> [!NOTE]
Expand All @@ -38,7 +39,7 @@ The data is then serialized and compressed.
> Include this library as build dependency and as normal dependeny!
```
cargo add --build --features build license-fetcher
cargo add --build --features "build github git cache" license-fetcher
cargo add license-fetcher
```

Expand All @@ -53,6 +54,7 @@ fn main() {
generate_package_list_with_licenses();
println!("cargo::rerun-if-changed=build.rs");
println!("cargo::rerun-if-changed=Cargo.lock");
println!("cargo::rerun-if-changed=Cargo.toml");
}
```

Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
//! | `frozen` | Panics if `Cargo.lock` needs to be updated for `cargo metadata` to run. |
//! | `git` | Enables asnyc `git clone` fallback for license fetching. `git` required.|
//! | `ignore-git-missing` | Disables panic when git cannot be executed. |
//! | `cache` | Adds caching for license fetching. |
//!

Expand Down

0 comments on commit 71934b7

Please sign in to comment.