datrs / hypercore

Secure, distributed, append-only log
https://docs.rs/hypercore
Apache License 2.0
327 stars 37 forks source link

document src/lib.rs #62

Closed FreddieRidell closed 5 years ago

FreddieRidell commented 5 years ago

🔦 documentation change

adds additional documentation to the root of the crate, making it easier for first-time users to use the library.

line 33 uses a markdown link syntax that lets you create links using rust's module syntax. This is available on nightly rust only, which docs.rs uses to build docs, but I understand if you don't want to use a nightly feature.