summaryrefslogtreecommitdiff
path: root/plugins/mise/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/mise/README.md')
-rw-r--r--plugins/mise/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/plugins/mise/README.md b/plugins/mise/README.md
new file mode 100644
index 000000000..8ec05aab9
--- /dev/null
+++ b/plugins/mise/README.md
@@ -0,0 +1,32 @@
+# mise
+
+Adds integration with [mise](https://github.com/jdx/mise) (formerly `rtx`), a runtime executor compatible with
+npm, nodenv, pyenv, etc. mise is written in rust and is very fast. 20x-200x faster than asdf. With that being
+said, mise is compatible with asdf plugins and .tool-versions files. It can be used as a drop-in replacement.
+
+## Installation
+
+1. [Download & install mise](https://github.com/jdx/mise#installation) by running the following:
+
+```bash
+curl https://mise.jdx.dev/install.sh | sh
+```
+
+2. [Enable mise](https://github.com/jdx/mise#quickstart) by adding it to your `plugins` definition in
+ `~/.zshrc`.
+
+```bash
+plugins=(mise)
+```
+
+## Usage
+
+See the [mise readme](https://github.com/jdx/mise#table-of-contents) for information on how to use mise. Here
+are a few examples:
+
+```bash
+mise install node Install the current version specified in .tool-versions/.mise.toml
+mise use -g node@system Use system node as global default
+mise install node@20.0.0 Install a specific version number
+mise use -g node@20 Use node-20.x as global default
+```