diff options
| author | 魏曹先生 <1992414357@qq.com> | 2026-05-03 01:31:04 +0800 |
|---|---|---|
| committer | 魏曹先生 <1992414357@qq.com> | 2026-05-03 01:31:04 +0800 |
| commit | 8422e0ada52d8036c32257d84f069776e520079e (patch) | |
| tree | b3d3c1aabc40d1c4ab35467fef6f68b6100779a4 /mingling | |
| parent | 8f44a3e779fb8ee66c8f51b49d6c77e5a80e3821 (diff) | |
Add missing articles and improve documentation
Diffstat (limited to 'mingling')
| -rw-r--r-- | mingling/Cargo.toml | 7 | ||||
| -rw-r--r-- | mingling/src/lib.rs | 4 |
2 files changed, 8 insertions, 3 deletions
diff --git a/mingling/Cargo.toml b/mingling/Cargo.toml index 45bbaa1..61a6c2b 100644 --- a/mingling/Cargo.toml +++ b/mingling/Cargo.toml @@ -5,7 +5,7 @@ edition = "2024" authors = ["Weicao-CatilGrass"] license = "MIT OR Apache-2.0" readme = "README.md" -description = "Rust CLI framework for many subcmds & complex workflows, reduces boilerplate via proc macros, focus on biz logic" +description = "A Rust CLI framework for many subcmds & complex workflows, reduces boilerplate via proc macros, focus on biz logic" keywords = ["cli", "framework", "procedural", "subcommand", "command-line"] categories = ["command-line-interface"] repository = "https://github.com/catilgrass/mingling" @@ -15,12 +15,15 @@ serde = { version = "1", features = ["derive"] } tokio = { version = "1", features = ["full"] } mingling = { path = ".", features = ["comp", "general_renderer", "parser"] } +[package.metadata.docs.rs] +features = ["general_renderer", "repl", "comp", "parser"] + [features] nightly = ["mingling_core/nightly", "mingling_macros/nightly"] debug = ["mingling_core/debug"] async = ["mingling_core/async", "mingling_macros/async"] -default = ["mingling_core/default"] +default = ["mingling_core/default", "mingling_macros/default"] clap = ["mingling_core/clap", "mingling_macros/clap"] general_renderer = [ diff --git a/mingling/src/lib.rs b/mingling/src/lib.rs index ed168ff..fa81f76 100644 --- a/mingling/src/lib.rs +++ b/mingling/src/lib.rs @@ -1,7 +1,7 @@ //! Mingling //! //! # Intro -//! `Mingling` is a Rust command-line framework. Its name comes from the Chinese Pinyin for "命令", which means "Command". +//! A Rust CLI framework for many subcmds & complex workflows, reduces boilerplate via proc macros, focus on biz logic //! //! # Use //! @@ -51,10 +51,12 @@ //! ``` //! //! # Features +//! - `async` enables async runtime support for command execution, see [example](_mingling_examples/example_async/index.html) for details //! - `comp` enables command completion functionality, see [example](_mingling_examples/example_completion/index.html) for details //! - `parser` enables the `mingling::parser` module, see [example](_mingling_examples/example_picker/index.html) for details //! - `general_renderer` adds support for serialized output formats such as JSON and YAML, see [example](_mingling_examples/example_general_renderer/index.html) for details //! +//! //! # Examples //! `Mingling` provides detailed usage examples for your reference. //! See [Examples](_mingling_examples/index.html) |