Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-13 22:32:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(readme): Expand generate's readme

Browse source 
Modeled it after clap's README.

The lib.rs is written in a way that cause the example to be merged in.
This commit is contained in:
Ed Page 2021-12-11 19:01:48 -06:00
parent b5cc5f0c5b
commit 87d4400f1a
1 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
clap_generate/README.md
View file

@ -1,12 +1,23 @@
<!-- omit in TOC -->
# clap_generate
> **Shell completion generation for `clap`**
[![Crates.io](https://img.shields.io/crates/v/clap_generate?style=flat-square)](https://crates.io/crates/clap_generate)
[![Crates.io](https://img.shields.io/crates/d/clap_generate?style=flat-square)](https://crates.io/crates/clap_generate)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-APACHE)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-MIT)
Generates completions (and other things) for [`clap`](https://github.com/clap-rs/clap) based CLIs
Dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).
- [Documentation](https://docs.rs/clap_generate)
- [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
- [CONTRIBUTING](CONTRIBUTING.md)
1. [About](#about)
2. [API Reference](https://docs.rs/clap_generate)
3. [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
4. [CONTRIBUTING](CONTRIBUTING.md)
5. [Sponsors](../README.md#sponsors)
## About
### Related Projects
- [clap_generate_fig](https://crates.io/crates/clap_generate_fig) for [fig](https://fig.io/) shell completion support