Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

Commit e7d91f6

Browse files
committed
README updates based on feedback
1 parent facfb6e commit e7d91f6

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,9 @@ To start managing dependencies using dep, run the following from your project ro
4141

4242
```sh
4343
$ dep init
44-
$ dep ensure -update
4544
```
4645

47-
`dep init` will do the following:
46+
This does the following:
4847

4948
1. Look for [existing dependency management files](docs/FAQ.md#what-external-tools-are-supported) to convert
5049
1. Check if your dependencies use dep
@@ -57,10 +56,13 @@ $ dep ensure -update
5756

5857
## Usage
5958

60-
There is one main subcommand you will use: `dep ensure`. `ensure` synchronizes
61-
your dependencies in `vendor/` to make sure they match what's in your `import`s
62-
and `Gopkg.toml`. `dep ensure` is safe to run early and often. See the help text
63-
for more detailed usage instructions.
59+
There is one main subcommand you will use: `dep ensure`. `ensure` first makes
60+
sure `Gopkg.lock` is consistent with your `import`s and `Gopkg.toml`. If any
61+
changes are detected, it then populates `vendor/` with exactly what's described
62+
in `Gopkg.lock`.
63+
64+
`dep ensure` is safe to run early and often. See the help text for more detailed
65+
usage instructions.
6466

6567
```sh
6668
$ dep help ensure
@@ -70,6 +72,8 @@ $ dep help ensure
7072

7173
(if your `vendor/` directory isn't [checked in with your code](](docs/FAQ.md#should-i-commit-my-vendor-directory)))
7274

75+
<!-- may change with https://github.com/golang/dep/pull/489 -->
76+
7377
```sh
7478
$ dep ensure
7579
```
@@ -80,8 +84,8 @@ matches the constraints from the manifest. If the dependency is missing from
8084

8185
### Adding a dependency
8286

83-
1. Add the `import` in your source code file(s).
84-
1. Download via dep.
87+
1. `import` the package in your `*.go` source code file(s).
88+
1. Run the following command to update your `Gopkg.lock` and populate `vendor/` with the new dependency.
8589

8690
```sh
8791
$ dep ensure
@@ -156,7 +160,11 @@ Don't run `dep ensure` until you're done. `dep ensure` will reinstall the
156160
dependency into `vendor/` based on your manifest, as if you were installing from
157161
scratch.
158162
159-
To test out code that is pushed, see [changing dependencies](#changing-dependencies).
163+
This solution works for short-term use, but for something long-term, take a look
164+
at [virtualgo](https://github.com/GetStream/vg).
165+
166+
To test out code that has been pushed as a new version, or to a branch or fork,
167+
see [changing dependencies](#changing-dependencies).
160168
161169
## Feedback
162170

0 commit comments

Comments
 (0)