Browse Source

add readme for the rust plugin

jotaro-sama 5 years ago
parent
commit
35aa3c1331
1 changed files with 15 additions and 0 deletions
  1. 15 0
      plugins/rust/README.md

+ 15 - 0
plugins/rust/README.md

@@ -0,0 +1,15 @@
+# rust
+
+This plugin adds completion for [`rustc`](https://doc.rust-lang.org/rustc/index.html), the compiler for the Rust programming language.
+
+To use it, add `rust` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... rust)
+```
+
+## Aliases
+
+| Command          | Description                                                                     |
+|------------------|---------------------------------------------------------------------------------|
+| `rustc`          | Compiler for the Rust language                                                  |