diff --git a/README.md b/README.md new file mode 100644 index 0000000..00c5552 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# matrix-dump + +Matrix Protocol Dumper + +## Usage + +Sample command: + +```sh +mkdir -p config + +cargo run --release -- --username @eternal_flame:matrix.org -f alikia +``` + diff --git a/src/lib.rs b/src/lib.rs index ccf6c12..cf21f5c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -43,7 +43,10 @@ pub struct Args { #[clap(long, default_value = "Matrix.org Protocol Dumper by Yumechi")] pub device_name: Option, - #[clap(long)] + #[clap( + long, + help = "If you lost the token but still have the keys, specify the device ID here" + )] pub device_id: Option, #[clap(long, default_value = "config/token.json")] @@ -52,7 +55,7 @@ pub struct Args { #[clap(short, long, default_value = "dump")] pub out_dir: String, - #[clap(long)] + #[clap(short, long, help = "Filter rooms by name or ID by substring")] pub filter: Vec, #[clap(long, short = 'j', default_value = "4")] @@ -61,7 +64,7 @@ pub struct Args { #[clap(long, default_value = "config/e2e.db")] pub e2e_db: String, - #[clap(long)] + #[clap(long, help = "Read the password from a file")] pub password_file: Option, #[clap(