docs: corrects notes about v2 vs v3 branches

This commit is contained in:
Kevin K 2019-10-29 22:30:17 -04:00
parent 1cc872b369
commit 4fdca7b4e6
No known key found for this signature in database
GPG key ID: 17218E4B3692F01A

View file

@ -8,17 +8,18 @@ Windows: [![Build status](https://ci.appveyor.com/api/projects/status/ejg8c33dn3
Command Line Argument Parser for Rust
# Important note on clap 3.0
Clap 3.0 is under development and available on the [v3-master](https://github.com/clap-rs/clap/tree/v3-master). When sending a pull request, ensure that it is against v3-master branch and not already covered by the 3.0 refactor. Thanks!
It is a simple-to-use, efficient, and full-featured library for parsing command line arguments and subcommands when writing console/terminal applications.
It is a simple-to-use, efficient, and full-featured library for parsing command line arguments and subcommands when writing console/terminal applications.
* [documentation](https://docs.rs/clap/)
* [website](https://clap.rs/)
* [video tutorials](https://www.youtube.com/playlist?list=PLza5oFLQGTl2Z5T8g1pRkIynR3E0_pc7U)
# Important note on clap 3.0
Clap 3.0 is under development and available on the [`master` branch](https://github.com/clap-rs/clap/tree/master), however the latest offically released version is still v2.33 (on the [`v2-master` branch](https://github.com/clap-rs/clap/tree/v2-master)).
Please consider supporting v3.0 moving forward, however if sending a pull request that is for v2.x please ensure that it is against `v2-master` branch. Thanks! Also please note that v2.x will not remain in active development (sans security fixes) once v3.0 is officially released.
Table of Contents
=================