Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattmc3 committed Sep 12, 2022
1 parent 15e686c commit 3c975d9
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,33 @@ The full documentation can be found at [https://getantidote.github.io][getantido

## Installation

The easiest way to get stated using antidote is to call the `antidote load` command from your `.zshrc`:
### Install with git

You can install the latest release of antidote by cloning it with `git`:

```zsh
# first, run this from an interactive zsh terminal session:
git clone --depth=1 https://github.com/mattmc3/antidote.git ${ZDOTDIR:-~}/.antidote
```

### Install with a plugin manager

antidote may also be available in your system's plugin manager:

- [homebrew](https://formulae.brew.sh/formula/antidote): `brew install antidote`
- [Arch AUR](https://aur.archlinux.org/packages/zsh-antidote): `yay -S antidote`

### .zshrc

After installation, the simplest way to use antidote is to call the `antidote load` command from your `.zshrc`:

```zsh
# clone antidote if necessary
if ! [[ -e ${ZDOTDIR:-~}/.antidote ]]; then
git clone https://github.com/mattmc3/antidote.git ${ZDOTDIR:-~}/.antidote
fi
# now, simply add these two lines in your ~/.zshrc

# source antidote and load plugins from `${ZDOTDIR:-~}/.zsh_plugins.txt`
# source antidote
source ${ZDOTDIR:-~}/.antidote/antidote.zsh

# initialize plugins statically with ${ZDOTDIR:-~}/.zsh_plugins.txt
antidote load
```

Expand Down

0 comments on commit 3c975d9

Please sign in to comment.