summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/scala/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/scala/README.md b/plugins/scala/README.md
new file mode 100644
index 000000000..957261d9e
--- /dev/null
+++ b/plugins/scala/README.md
@@ -0,0 +1,15 @@
+## Scala plugin
+
+Completion script for [scala and scalac](https://www.scala-lang.org/) commands.
+
+To use it, add `scala` to the plugins array of your zshrc file:
+```
+plugins=(... scala)
+```
+
+## Aliases
+
+| Command | Description |
+|------------------|---------------------------------------------------------------------------------|
+| `scala` | Run code in the Scala language |
+| `scalac` | Compiler for the Scala language |