public/zsh-nvm
1
0
Fork 0
mirror of https://github.com/lukechilds/zsh-nvm.git synced 2025-01-30 09:47:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

changes to readme.md

Browse Source
This commit is contained in:
Douglas Rogers 2017-10-13 11:51:41 -04:00
parent 2d88fd5c8f
commit a7f325f169
1 changed files with 53 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
README.md
View File

@ -8,6 +8,59 @@ The plugin will install the latest stable release of `nvm` if you don't already
Although this is written as a zsh plugin, it also works with bash if you follow the [manual installation instructions](#manually).
## Installation
### Using [Antigen](https://github.com/zsh-users/antigen)
Bundle `zsh-nvm` in your `.zshrc`
```shell
antigen bundle lukechilds/zsh-nvm
```
### Using [zplug](https://github.com/b4b4r07/zplug)
Load `zsh-nvm` as a plugin in your `.zshrc`
```shell
zplug "lukechilds/zsh-nvm"
```
### Using [zgen](https://github.com/tarjoilija/zgen)
Include the load command in your `.zshrc`
```shell
zgen load lukechilds/zsh-nvm
```
### As an [Oh My ZSH!](https://github.com/robbyrussell/oh-my-zsh) custom plugin
Clone `zsh-nvm` into your custom plugins repo
```shell
git clone https://github.com/lukechilds/zsh-nvm ~/.oh-my-zsh/custom/plugins/zsh-nvm
```
Then load as a plugin in your `.zshrc`
```shell
plugins+=(zsh-nvm)
```
Keep in mind that plugins need to be added before `oh-my-zsh.sh` is sourced.
### Manually
Clone this repository somewhere (`~/.zsh-nvm` for example)
```shell
git clone https://github.com/lukechilds/zsh-nvm.git ~/.zsh-nvm
```
Then source it in your `.zshrc` (or `.bashrc`)
```shell
source ~/.zsh-nvm/zsh-nvm.plugin.zsh
```
## Usage
Once the plugin's installed `nvm` will be available. You'll probably want to load this as one of your first plugins so `node`/`npm` is available for any other plugins that may require them.
@ -122,58 +175,6 @@ export NVM_AUTO_USE=true
antigen bundle lukechilds/zsh-nvm
```
## Installation
### Using [Antigen](https://github.com/zsh-users/antigen)
Bundle `zsh-nvm` in your `.zshrc`
```shell
antigen bundle lukechilds/zsh-nvm
```
### Using [zplug](https://github.com/b4b4r07/zplug)
Load `zsh-nvm` as a plugin in your `.zshrc`
```shell
zplug "lukechilds/zsh-nvm"
```
### Using [zgen](https://github.com/tarjoilija/zgen)
Include the load command in your `.zshrc`
```shell
zgen load lukechilds/zsh-nvm
```
### As an [Oh My ZSH!](https://github.com/robbyrussell/oh-my-zsh) custom plugin
Clone `zsh-nvm` into your custom plugins repo
```shell
git clone https://github.com/lukechilds/zsh-nvm ~/.oh-my-zsh/custom/plugins/zsh-nvm
```
Then load as a plugin in your `.zshrc`
```shell
plugins+=(zsh-nvm)
```
Keep in mind that plugins need to be added before `oh-my-zsh.sh` is sourced.
### Manually
Clone this repository somewhere (`~/.zsh-nvm` for example)
```shell
git clone https://github.com/lukechilds/zsh-nvm.git ~/.zsh-nvm
```
Then source it in your `.zshrc` (or `.bashrc`)
```shell
source ~/.zsh-nvm/zsh-nvm.plugin.zsh
```
## Tests
To run the tests you'll need to install [Urchin](https://github.com/tlevine/urchin#install). You'll also need to run the tests in an environment that doesn't already have `node` or `nvm` loaded.