Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
gnkz committed Oct 26, 2023
1 parent 7124044 commit 50ef093
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,20 @@ Over time, Vulcan will grow to include more functionality and utilities, eventua

## Installation

Install the latest release by running:

```
$ forge install nomoixyz/vulcan
```

Or install a specific release with:

```
$ forge install nomoixyz/vulcan@v0.4.2
$ forge install nomoixyz/vulcan@x.y.z
```

Release tags can be found [here](https://github.com/nomoixyz/vulcan/releases)

## Usage

See the [Vulcan Book](https://nomoixyz.github.io/vulcan/) for detailed usage information.
Expand Down
11 changes: 10 additions & 1 deletion docs/src/guide/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Installation

In an existing Foundry project, use `forge install`:

```
$ forge install nomoixyz/vulcan
```

Or install a specific release with:

```
$ forge install nomoixyz/vulcan@v0.4.2
$ forge install nomoixyz/vulcan@x.y.z
```

Release tags can be found [here](https://github.com/nomoixyz/vulcan/releases)

0 comments on commit 50ef093

Please sign in to comment.