notify-rs / notify

🔭 Cross-platform filesystem notification library for Rust.
https://docs.rs/notify
2.77k stars 222 forks source link

Not adequate README/links to documentation on crates.io for file-id #571

Closed 0xCCF4 closed 4 months ago

0xCCF4 commented 9 months ago

Hey, I just searched for a crate that reads out file ids for linux and windows and found the file-id crate.

When viewing the crate on https://crates.io/crates/file-id the page shows misleading information. It seems like somehow the README and Cargo.toml of the main (notify) repo was published for the file-id crate (including a wrong link to the notify documentation https://docs.rs/notify).

It's a minor inconvenience to guess the correct documentation link https://docs.rs/file-id/latest/file_id/ and that the README (that exists here: https://github.com/notify-rs/notify/blob/main/file-id/README.md) is not displayed on the crates.io https://crates.io/crates/file-id page.

Interestingly when viewing the source on doc.rs https://docs.rs/crate/file-id/latest/source/Cargo.toml, it seems like the correct files were uploaded but https://docs.rs/crate/file-id/latest/source/Cargo.toml.orig seems to be invalid.

Looking forward to a fix