📝 Add long description to clap help

Replaces the None value with a descriptive str
This commit is contained in:
Malted 2023-06-10 18:11:54 +01:00 committed by Ben
parent 1ec7ea7d3c
commit f3d086effc

View file

@ -6,7 +6,12 @@ use tun::TunInterface;
#[command(name = "Burrow")]
#[command(author = "Hack Club <team@hackclub.com>")]
#[command(version = "0.1")]
#[command(about = "Burrow is a tool for burrowing through firewalls, built by teenagers at Hack Club.", long_about = None)]
#[command(
about = "Burrow is a tool for burrowing through firewalls, built by teenagers at Hack Club.",
long_about = "Burrow is a 🚀 blazingly fast 🚀 tool designed to penetrate unnecessarily restrictive firewalls, providing teenagers worldwide with secure, less-filtered, and safe access to the internet!
It's being built by teenagers from Hack Club, in public! Check it out: https://github.com/hackclub/burrow
Spotted a bug? Please open an issue! https://github.com/hackclub/burrow/issues/new"
)]
struct Cli {
#[command(subcommand)]
@ -15,7 +20,7 @@ struct Cli {
#[derive(Subcommand)]
enum Commands {
/// Adds files to myapp
/// Start Burrow
Start(StartArgs),
}