summaryrefslogtreecommitdiff
path: root/plugins/ros/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-12-27 02:37:27 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-12-27 02:37:27 +0100
commit67b5bfaaa316212221a01d4fe2eedcd0fc64c230 (patch)
tree5c6f76ef95b48a7c7acf6c9c3d0b1c2e2fd53b62 /plugins/ros/README.md
parent8ea20fdca794a2a2c2f39cebd1e1861f9f0c6fbb (diff)
downloadzsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.tar.gz
zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.tar.bz2
zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.zip
Rename some plugin READMEs for consistency
Diffstat (limited to 'plugins/ros/README.md')
-rw-r--r--plugins/ros/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/ros/README.md b/plugins/ros/README.md
new file mode 100644
index 000000000..83573e499
--- /dev/null
+++ b/plugins/ros/README.md
@@ -0,0 +1,10 @@
+# Roswell Plugin
+
+This plugin adds completions and aliases for [Roswell](https://github.com/roswell/roswell/).
+
+To use it, add `ros` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... ros)
+```
+