Documentation of top level module should contain summary of what this crate is about.

[steffahn]

Right now, the GitHub README (also displayed on https://crates.io/crates/phf) contains important information, particularly that this crate is offering a datastructure using a “perfect hash function” but also what algorithm is used, etc…

When you instead were to navigate to https://docs.rs/phf to learn about this crate, some crucial information (at least the two things listed above) seems to be missing.

I’d suggest that most relevant information about phf that’s present in the README, should be added to the library docs as-well, in particular the fact that “phf” stands for “perfect hash function”.