documentation

kingwingfly · Feb 6, 2024 · f8b0c6c · f8b0c6c
1 parent 2414494
commit f8b0c6c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -147,6 +147,8 @@ Options:
 
 ### Example
 ```sh
+# auto complete is supported; e.g:
+$ fav completion fish > ~/.config/fish/completions/fav.fish
 # init for bilibili
 $ fav init bili
 # scan code to login
@@ -202,6 +204,7 @@ _For more examples, please refer to the [Documentation](https://github.com/kingw
 - [ ] Sync
 - [ ] Serve
 - [ ] Tui
+- [ ] Dynamic completion
 
 See the [open issues](https://github.com/kingwingfly/fav/issues) for a full list of proposed features (and known issues).
 

diff --git a/src/cli/mod.rs b/src/cli/mod.rs
@@ -116,7 +116,9 @@ enum Commands {
         #[arg(long, short, value_enum)]
         clarity: Option<Qn>,
     },
+    /// Completions for the shell
     Completion {
+        /// The shell to generate completions for
         #[arg(value_enum)]
         shell: clap_complete::Shell,
     },