[![MIT][s2]][l2] [![Latest Version][s1]][l1] [![docs][s3]][l3] [![Chat on Miaou][s4]][l4]
[s1]: https://img.shields.io/crates/v/cradoc.svg
[l1]: https://crates.io/crates/cradoc
[s2]: https://img.shields.io/badge/license-MIT-blue.svg
[l2]: LICENSE
[s3]: https://docs.rs/cradoc/badge.svg
[l3]: https://docs.rs/cradoc/
[s4]: https://miaou.dystroy.org/static/shields/room.svg
[l4]: https://miaou.dystroy.org/3
# cradoc
**cradoc** (a *mot-valise* for *crate* *doc*)
leverages Rust's documentation generation to automatically
maintain other documents up to date.
The current version of cradoc does only one thing: ensure
markdown files in your repo (eg the README.md) contain an up-to-date
version of the crate documentation.
Insert `<!-- cradoc -->` in your markdown file where you want
the crate documentation to appear, run `cradoc` in your repo,
and the markdown file will be updated accordingly.
There are several previous crates with the same exact feature, most
especially [cargo-readme](https://crates.io/crates/cargo-rdme).
It's very probable the crate you need is one of those previous ones.
The main reason I made this alternative is that cargo-readme does not
currently properly handle intra-links (this is being worked on, don't
discard this much more mature crate).
To see an example of what cradoc produces, head up to
[the readme of lazy-regex](https://github.com/Canop/lazy-regex).
This README full of links is made from the crate's lib.rs which
is also used for the [crate documentation](https://docs.rs/lazy-regex).
(other features should come later)