Skip to content

Commit

Permalink
README: Add missing https: prefix in many lib.rs links
Browse files Browse the repository at this point in the history
By missing `https:`, the [current crates.io page for `cavif`] and
[`ravif`] seem to link straight to files in the GitHub repository, which
doesn't exist.  lib.rs in contrast seems to link this correctly to its
own site.

For `cavif`, also mention that it goes through the `ravif` crate which
disambiguates the first paragraphs of both crates and makes it easier to
understand the total dependency hierarchy.

[current crates.io page for `cavif`]: https://crates.io/crates/cavif/1.5.6
[`ravif`]: https://crates.io/crates/ravif/0.11.11
  • Loading branch information
MarijnS95 authored and kornelski committed Dec 12, 2024
1 parent 51bc895 commit 772eea7
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license = "BSD-3-Clause"
readme = "README.md"
keywords = ["avif", "png2avif", "jpeg2avif", "convert", "av1"]
categories = ["command-line-utilities", "multimedia::images", "multimedia::encoding"]
homepage = "https://lib.rs/cavif"
homepage = "https://lib.rs/crates/cavif"
repository = "https://github.com/kornelski/cavif-rs"
include = ["README.md", "LICENSE", "/src/*.rs"]
rust-version = "1.70"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `cavif` — PNG/JPEG to AVIF converter

Encoder/converter for AVIF images. Based on [rav1e](//lib.rs/crates/rav1e) and [avif-serialize](https://lib.rs/crates/avif-serialize), which makes it an almost pure-Rust tool (it uses C LCMS2 for color profiles).
Encoder/converter for AVIF images. Based on [`rav1e`](https://lib.rs/crates/rav1e) and [`avif-serialize`](https://lib.rs/crates/avif-serialize) via the [`ravif`](https://lib.rs/crates/ravif) crate, which makes it an almost pure-Rust tool (it uses C LCMS2 for color profiles).

## Installation

Expand Down
2 changes: 1 addition & 1 deletion ravif/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license = "BSD-3-Clause"
readme = "README.md"
keywords = ["avif", "convert", "av1", "rav1f", "cav1f"]
categories = ["multimedia::images", "multimedia::encoding"]
homepage = "https://lib.rs/ravif"
homepage = "https://lib.rs/crates/ravif"
repository = "https://github.com/kornelski/cavif-rs"
include = ["README.md", "LICENSE", "Cargo.toml", "/src/*.rs"]
rust-version = "1.70" # as low as `cargo -Zminimal-versions generate-lockfile` will let us go
Expand Down
6 changes: 3 additions & 3 deletions ravif/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `ravif` — Pure Rust library for AVIF image encoding

Encoder for AVIF images. Based on [rav1e](//lib.rs/rav1e) and [avif-serialize](//lib.rs/avif-serialize).
Encoder for AVIF images. Based on [`rav1e`](https://lib.rs/crates/rav1e) and [`avif-serialize`](https://lib.rs/crates/avif-serialize).

The API is just a single `encode_rgba` function call that spits an AVIF image.
The API is just a single `encode_rgba()` function call that spits an AVIF image.

This library powers [`cavif`](//lib.rs/cavif) encoder. It has encoding configuration specifically tuned for still images, and gives better quality/performance than stock rav1e.
This library powers the [`cavif`](https://lib.rs/crates/cavif) encoder. It has an encoding configuration specifically tuned for still images, and gives better quality/performance than stock `rav1e`.

0 comments on commit 772eea7

Please sign in to comment.