From 62e454b7fe4ab15a979928656c6ea822615b99f3 Mon Sep 17 00:00:00 2001 From: Rob Mulholand Date: Wed, 17 Jul 2019 15:29:24 -0500 Subject: [PATCH] Update docs to reflect using go mod --- README.md | 11 ++++++----- documentation/custom-transformers.md | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1e60b42b..c9aad7fc 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ data from VulcanizeDB's underlying Postgres database and making it accessible. 1. [Configuring a synced Ethereum node](#configuring-a-synced-ethereum-node) ### Dependencies - - Go 1.11+ + - Go 1.12+ - Postgres 11.2 - Ethereum Node - [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8.23+) @@ -46,16 +46,17 @@ Download the codebase to your local `GOPATH` via: `go get github.com/vulcanize/vulcanizedb` -Move to the project directory and use [golang/dep](https://github.com/golang/dep) to install the dependencies: +Move to the project directory: `cd $GOPATH/src/github.com/vulcanize/vulcanizedb` -`dep ensure` - -Once the dependencies have been successfully installed, build the executable with: +Be sure you have enabled Go Modules (`export GO111MODULE=on`), and build the executable with: `make build` +If you need to use a different dependency than what is currently defined in `go.mod`, it may helpful to look into [the replace directive](https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive). +This instruction enables you to point at a fork or the local filesystem for dependency resolution. + If you are running into issues at this stage, ensure that `GOPATH` is defined in your shell. If necessary, `GOPATH` can be set in `~/.bashrc` or `~/.bash_profile`, depending upon your system. It can be additionally helpful to add `$GOPATH/bin` to your shell's `$PATH`. diff --git a/documentation/custom-transformers.md b/documentation/custom-transformers.md index 3e7747b0..c4782c54 100644 --- a/documentation/custom-transformers.md +++ b/documentation/custom-transformers.md @@ -39,7 +39,7 @@ or [contract](../../staging/libraries/shared/watcher/contract_watcher.go#L68) wa * If the base vDB migrations occupy this path as well, they need to be in their `goose fix`ed form as they are [here](../../staging/db/migrations) -To update a plugin repository with changes to the core vulcanizedb repository, run `dep ensure` to update its dependencies. +To update a plugin repository with changes to the core vulcanizedb repository, use your dependency manager to install the desired version of vDB. ## Building and Running Custom Transformers ### Commands