diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..81fccc0 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Document your crate's feature flags + +[](https://crates.io/crates/document-features) +[](https://docs.rs/document-features/) + +This crate provides a macro that extracts documentation comments from Cargo.toml + +To use this crate, add `#![doc = document_features::document_features!()]` in your crate documentation. +The `document_features!()` macro reads your `Cargo.toml` file, extracts feature comments and generates +a markdown string for your documentation. + +Use `## ` and `#! ` comments in your Cargo.toml to document features, for example: + +```toml +[dependencies] +document-features = "0.2" +## ... + +[features] +## The foo feature enables the `foo` functions +foo = [] +## The bar feature enables the [`bar`] module +bar = [] + +#! ### Experimental features +#! The following features are experimental + +## Activate the fusion reactor +fusion = [] +``` + +These comments keep the feature definition and documentation next to each other, and they are then +rendered into your crate documentation. + +Check out the [documentation](https://docs.rs/document-features/) for more details. + +## Contributions + +Contributions are welcome. We accept pull requests and bug reports. + +## License + +MIT OR Apache-2.0 |