Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consider to add a README.md to crates.io #559

Closed
rusty-snake opened this issue Jul 13, 2021 · 0 comments
Closed

Consider to add a README.md to crates.io #559

rusty-snake opened this issue Jul 13, 2021 · 0 comments

Comments

@rusty-snake
Copy link

Currently this crate does has no README.md (and no readme key in Cargo.toml) causing it to be rendered without a README on crates.io. Why is that bad? Crates which miss a README on crates.io look (and often are) not well maintained, unfinished and/or experimental. Even a samll README with a titel, a description and one example looks better.
@phimuemue phimuemue mentioned this issue Jul 16, 2021
Merged
bors bot added a commit that referenced this issue Jul 29, 2021
@bors @phimuemue @atouchet
Merge #561
966a513 
561: Add crude README to Cargo.toml r=phimuemue a=phimuemue

Addressing #559, this adds our README to Cargo.toml.

Instead of creating a separate one, I suggest simply redirecting to the existing one and update it if needed.

Co-authored-by: philipp <descpl@yahoo.de>
Co-authored-by: Alex Touchet <alextouchet@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rusty-snake @Philippe-Cholet