feat: Bump version to 0.2.2 and add usage section to README

amiyzku · Oct 27, 2023 · e4c66b5 · e4c66b5
1 parent f272166
commit e4c66b5
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git 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
@@ -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 <POLLING_INTERVAL_MS>  [default: 3000]
+  -h, --help                                       Print help
+  -V, --version                                    Print version
+
+```
+
 ## Setup as CLI tool
 
 <https://github.com/amiyzku/max-mic-volume/releases>