summaryrefslogtreecommitdiff
path: root/plugins/asdf/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/asdf/README.md')
-rw-r--r--plugins/asdf/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/plugins/asdf/README.md b/plugins/asdf/README.md
new file mode 100644
index 000000000..e8aa976bc
--- /dev/null
+++ b/plugins/asdf/README.md
@@ -0,0 +1,27 @@
+## asdf
+
+**Maintainer:** [@RobLoach](https://github.com/RobLoach)
+
+Adds integration with [asdf](https://github.com/asdf-vm/asdf), the extendable version manager, with support for Ruby, Node.js, Elixir, Erlang and more.
+
+### Installation
+
+1. Enable the plugin by adding it to your `plugins` definition in `~/.zshrc`.
+
+ ```
+ plugins=(asdf)
+ ```
+
+2. [Install asdf](https://github.com/asdf-vm/asdf#setup) by running the following:
+ ```
+ git clone https://github.com/asdf-vm/asdf.git ~/.asdf
+ ```
+
+### Usage
+
+See the [asdf usage documentation](https://github.com/asdf-vm/asdf#usage) for information on how to use asdf:
+
+```
+asdf plugin-add nodejs git@github.com:asdf-vm/asdf-nodejs.git
+asdf install nodejs 5.9.1
+```