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.

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

chacha20/salsa20/salsa20-core: Improve README.md #17

Closed
tarcieri opened this issue Jun 24, 2019 · 2 comments
Closed

chacha20/salsa20/salsa20-core: Improve README.md #17

tarcieri opened this issue Jun 24, 2019 · 2 comments
Labels
docs Documentation improvements help wanted

Comments

@tarcieri
Copy link
Member

tarcieri commented Jun 24, 2019

Each of these crates could use a README.md with some basic information, and the following added to their Cargo.toml files:

readme = "README.md"

Right now they look pretty bare on crates.io, e.g.:

https://crates.io/crates/chacha20

@newpavlov
Copy link
Member

Well, most crates in this org do not have per-crate READMEs right now. I think improving in-crate documentation should have a higher priority, as right now it's essentially non-existent for those crates.

Of course eventually it's worth to add READMEs as well, hopefully for all user-facing crates.

@newpavlov newpavlov added help wanted docs Documentation improvements labels Jun 24, 2019
@tarcieri
Copy link
Member Author

tarcieri commented Jun 24, 2019

I think crate-specific READMEs are important because it aids in discoverability through crates.io

tarcieri added a commit that referenced this issue Aug 16, 2019
Document chacha20 and salsa20 crates (closes #17)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements help wanted
Projects
None yet
Development

No branches or pull requests

2 participants