From e4c66b530a03fa2b0c3e29da6faf4253454c7d8d Mon Sep 17 00:00:00 2001 From: Yuma Miyazaki Date: Fri, 27 Oct 2023 23:33:35 +0900 Subject: [PATCH] feat: Bump version to 0.2.2 and add usage section to README --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 15 +++++++++++++++ 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 39d8cfb..e412145 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -224,7 +224,7 @@ dependencies = [ [[package]] name = "max-mic-volume" -version = "0.2.1" +version = "0.2.2" dependencies = [ "anyhow", "clap", diff --git a/Cargo.toml b/Cargo.toml index f1ae3b6..17f6644 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "max-mic-volume" -version = "0.2.1" +version = "0.2.2" edition = "2021" license = "MIT" description = "A simple CLI tool to set the microphone volume to the maximum in MacOS" diff --git a/README.md b/README.md index 1b5608f..d4aad43 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,21 @@ However, it does not maximize when muted. ![behavior](images/behavior.png) +## Usage + +```bash +$ ./max-mic-volume --help +A simple CLI tool to set the microphone volume to the maximum in MacOS + +Usage: max-mic-volume [OPTIONS] + +Options: + -p, --polling-interval-ms [default: 3000] + -h, --help Print help + -V, --version Print version + +``` + ## Setup as CLI tool