add readme for the rust plugin

2019-10-10 03:57:25 +02:00 · 2019-10-10 03:57:25 +02:00 · 35aa3c1331
commit 35aa3c1331
parent 710a3d5a1e
1 changed files with 15 additions and 0 deletions
--- a/plugins/rust/README.md
+++ b/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                                                  |