Browse Source

update readme

pull/3/head
Brett Langdon 10 years ago
parent
commit
15a1f1c144
1 changed files with 15 additions and 6 deletions
  1. +15
    -6
      README.md

+ 15
- 6
README.md View File

@ -1,6 +1,5 @@
git-vendor
==========
A work in progress git command for managing golang vendor dependencies.
`git-vendor` is a wrapper around `git-subtree` commands for checking out and updating vendored dependencies.
@ -11,11 +10,12 @@ A work in progress git command for managing golang vendor dependencies.
* `git vendor list` - list all current vendored dependencies, their source, and current vendored ref.
* `git vendor update <dir> <ref>` - update a vendored dependency to `<ref>`.
## Installation
## Example
## Example
Checkout github.com/brettlangdon/forge@v0.1.6 under vendor/github.com/brettlangdon/forge
```
$ # Checkout github.com/brettlangdon/forge@v0.1.6 under vendor/github.com/brettlangdon/forge
$ git vendor add https://github.com/brettlangdon/forge v0.1.6
git fetch https://github.com/brettlangdon/forge v0.1.6
warning: no common commits
@ -26,7 +26,10 @@ Resolving deltas: 100% (227/227), done.
From https://github.com/brettlangdon/forge
* tag v0.1.6 -> FETCH_HEAD
Added dir 'vendor/github.com/brettlangdon/forge'
$ # List current vendored dependencies
```
List current vendored dependencies
```
$ git vendor list
vendor/github.com/brettlangdon/forge
commit: a7afbba3821d74c5b722c9195b954effa3d7420f
@ -34,7 +37,10 @@ vendor/github.com/brettlangdon/forge
ref: v0.1.6
repo: https://github.com/brettlangdon/forge
$ # Update existing dependency to a newer version
```
Update existing dependency to a newer version
```
$ git vendor update vendor/github.com/brettlangdon/forge v0.1.7
warning: no common commits
remote: Counting objects: 411, done.
@ -48,7 +54,10 @@ Merge made by the 'recursive' strategy.
vendor/github.com/brettlangdon/forge/scanner.go | 4 ++++
vendor/github.com/brettlangdon/forge/test.cfg | 1 +
3 files changed, 7 insertions(+)
$ # List current vendored dependencies
```
List current vendored dependencies
```
$ git vendor list
vendor/github.com/brettlangdon/forge
commit: fcaa3c0cf3792fe3ad724c43d6db75f06fc5ecd5


Loading…
Cancel
Save