Skip to content

Commit

Permalink
Update the quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
intentionally-left-nil committed Jul 1, 2018
1 parent 1018817 commit 887cafe
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@
**wand** is a dependency manager that uses a _wand.json_ file to replace your deps() in mix.exs. This allows you to add, remove, and upgrade packages easily using the wand cli.

## Quickstart
**To install**: `mix archive.install hex wand --force && mix archive.install hex wand_core --force`
To install: `mix escript.install hex wand --force && mix archive.install hex wand_core --force`

**To use wand in a project**: `wand init`
To use wand in a project: `wand init`

**Add a dependency**: `wand add poison`
Add a dependency: `wand add poison`

**Remove a dependency**: `wand remove poison`
Remove a dependency: `wand remove poison`

**Upgrade a dependency**: `wand upgrade poison --latest`
Upgrade a dependency: `wand upgrade poison --latest`

**help**: `wand --help`
help: `wand --?`

# Installing wand

## Prerequisites
Wand requires [elixir](https://elixir-lang.org/install.html) before installing. You also need to have hex installed by running `mix local.hex`

## Installation
`mix archive.install hex wand --force && mix archive.install hex wand_core --force`
`mix escript.install hex wand --force && mix archive.install hex wand_core --force`

After installation, you need to add the escript directory to your `PATH`. This is usually `~/.mix/escripts`

Expand Down

0 comments on commit 887cafe

Please sign in to comment.