Skip to content

Commit

Permalink
📝 add plugin installation doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ptavares committed May 3, 2020
1 parent 1b03070 commit ec106ff
Showing 1 changed file with 61 additions and 1 deletion.
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,62 @@
# zsh-tgenv
zsh plugin for installing and loading tgenv

zsh plugin for installing and loading [tgenv](https://github.com/cunymatthieu/tgenv.git)
>Inpired by [zsh-pyenv](https://github.com/mattberther/zsh-pyenv)
## Usage

Once the plugin installed, `tgenv` will be available

### Using [Antigen](https://github.com/zsh-users/antigen)

Bundle `zsh-tgenv` in your `.zshrc`

```
antigen bundle ptavares/zsh-tgenv
```

### Using [zplug](https://github.com/b4b4r07/zplug)

Load `zsh-tgenv` as a plugin in your `.zshrc`

```
zplug "ptavares/zsh-tgenv"
```

### Using [zgen](https://github.com/tarjoilija/zgen)

Include the load command in your `.zshrc`

```
zget load ptavares/zsh-tgenv
```

### As an [Oh My ZSH!](https://github.com/robbyrussell/oh-my-zsh) custom plugin

Clone `zsh-tgenv` into your custom plugins repo and load as a plugin in your `.zshrc`

```shell
git clone https://github.com/ptavares/zsh-tgenv ~/.oh-my-zsh/custom/plugins/zsh-tgenv
```

```
plugins+=(zsh-tgenv)
```

Keep in mind that plugins need to be added before `oh-my-zsh.sh` is sourced.

### Manually

Clone this repository somewhere (`~/.zsh-tgenv` for example) and source it in your `.zshrc`

```shell
git clone https://github.com/ptavares/zsh-tgenv ~/.zsh-tgenv
```

```
source ~/.zsh-tfenv/zsh-tfenv.plugin.zsh
```

### License

[MIT](LICENCE)

0 comments on commit ec106ff

Please sign in to comment.