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

Commit

Permalink
Update README, FAQ to reflect production-readiness
Browse files Browse the repository at this point in the history
  • Loading branch information
sdboyer committed Jul 19, 2017
1 parent 14e9281 commit e1fcbe4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
4 changes: 1 addition & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ ___
## Concepts
### Does `dep` replace `go get`?

No, `dep` is an experiment and is still in its infancy. Depending on how this
experiment goes, it may be considered for inclusion in the go project in some form
or another in the future but that is not guaranteed.
No. `dep` and `go get` serve mostly different purposes.

Here are some suggestions for when you could use `dep` or `go get`:
> I would say that dep doesn't replace go get, but they both can do similar things. Here's how I use them:
Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ Dep is a prototype dependency management tool. It requires Go 1.7 or newer to co

## Current status

**Alpha**.
Functionality is known to be broken, missing or incomplete. Changes are planned
to the CLI commands soon. *It would be unwise to write scripts atop `dep` before then.*
The repository is open to solicit feedback and contributions from the community.
Please see below for feedback and contribution guidelines.

`Gopkg.toml` and `Gopkg.lock` have reached a stable structure, and it is safe to
commit them in your projects. We plan to add more to these files, but we
guarantee these changes will be backwards-compatible.
`dep` is safe for production use. That means two things:

* Any valid metadata file (`Gopkg.toml` and `Gopkg.lock`) will be readable and considered valid by any future version of `dep`.
* Generally speaking, it has comparable or fewer bugs than other tools out there.

That said, keep in mind the following:

* `dep` is still changing rapidly. If you need stability (e.g. for CI), it's best to rely on a released version, not tip.
* [Some changes](https://github.com/golang/dep/pull/489) are pending to the CLI interface. Scripting on dep before they land is unwise.
* `dep`'s exported API interface will continue to change in unpredictable, backwards-incompatible ways until we tag a v1.0.0 release.

## Context

Expand Down

0 comments on commit e1fcbe4

Please sign in to comment.