diff --git a/README.md b/README.md index 593e86e7..d4b3ac99 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/src/guide/installation.md b/docs/src/guide/installation.md index 23c0bceb..eb639503 100644 --- a/docs/src/guide/installation.md +++ b/docs/src/guide/installation.md @@ -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)