Skip to content

Commit 9b55a36

Browse files
committed
Change install instructions
go get doesn't work reliably since upstream deps may change at any time. I've added two pre-built binary releases to make it easier to install. You no longer need a go installed to compile docker-gen just to run it. Resolves #3
1 parent ad77c84 commit 9b55a36

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,17 @@ docker-gen can be used to generate various kinds of files for:
1414

1515
### Installation
1616

17+
Linux binaries for release [0.1.0](https://github.com/jwilder/docker-gen/releases)
18+
19+
* [amd64](https://github.com/jwilder/docker-gen/releases/download/0.1.0/docker-gen-linux-amd64-0.1.0.tar.gz)
20+
* [i386](https://github.com/jwilder/docker-gen/releases/download/0.1.0/docker-gen-linux-i386-0.1.0.tar.gz)
21+
22+
Download the version you need, untar, and install to your PATH.
23+
1724
```
18-
go get github.com/jwilder/docker-gen
25+
wget https://github.com/jwilder/docker-gen/releases/download/0.1.1/docker-gen-linux-amd64-0.1.0.tar.gz
26+
tar xvzf tar xvzf docker-gen-linux-amd64-0.1.0.tar.gz
27+
./docker-gen
1928
```
2029

2130
### Usage
@@ -60,6 +69,18 @@ docker-gen -notify "/bin/bash /tmp/etcd.sh" -interval 10 templates/etcd.tmpl /tm
6069
```
6170

6271

72+
### Development
73+
74+
This project uses [godep](https://github.com/tools/godep) for managing 3rd party dependencies. You'll need to install godep into your workspace before hacking on docker-gen.
75+
76+
```
77+
git clone <your fork>
78+
godep restore
79+
make
80+
```
81+
6382
### TODO
6483

84+
* Add Dockerfile and trusted build
85+
* Add event status for handling start and stop events differently
6586
* Add a way to filter out containers in templates

0 commit comments

Comments
 (0)