Skip to content

Commit 31b2d41

Browse files
committed
Avoid line-breaks in examples and remove TODOs in README.md
1 parent 9f627ae commit 31b2d41

File tree

1 file changed

+31
-29
lines changed

1 file changed

+31
-29
lines changed

README.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,46 +17,48 @@ Use an up-to-date version of [go](https://golang.org/dl)
1717

1818
To use the driver, you can download the sources and build it locally:
1919

20-
```
21-
# Tell GO where to find sources and where to put binaries (see also https://github.com/golang/go/wiki/SettingGOPATH)
22-
export GOPATH="$(pwd)"
23-
export GOBIN=$GOPATH/bin
24-
# Build the binary
25-
go get github.com/jonasprogrammer/docker-machine-driver-hetzner
26-
# Make the binary accessible to docker-machine
27-
export PATH="$PATH:$GOBIN"
28-
# Make docker-machine output help including hetzner-specific options
29-
docker-machine create --driver hetzner
30-
```
20+
# Tell GO where to find sources and where to put binaries
21+
# see also https://github.com/golang/go/wiki/SettingGOPATH
22+
export GOPATH="$(pwd)"
23+
export GOBIN=$GOPATH/bin
24+
# Build the binary
25+
go get github.com/jonasprogrammer/docker-machine-driver-hetzner
26+
# Make the binary accessible to docker-machine
27+
export PATH="$PATH:$GOBIN"
28+
# Make docker-machine output help including hetzner-specific options
29+
docker-machine create --driver hetzner
3130

3231
### For development
3332

3433
To compile the local sources, do the following:
3534

36-
```
37-
# Check out sources
38-
git clone https://github.com/JonasProgrammer/docker-machine-driver-hetzner.git
39-
# Tell GO where to find sources and where to put binaries (see also https://github.com/golang/go/wiki/SettingGOPATH)
40-
export GOPATH="$(pwd)"
41-
export GOBIN=$GOPATH/bin
42-
# Build the binary
43-
go get
44-
# Make the binary accessible to docker-machine
45-
export PATH="$PATH:$GOBIN"
46-
# Make docker-machine output help including hetzner-specific options
47-
docker-machine create --driver hetzner
48-
```
49-
TODO: restructure code
50-
TODO: Go version
51-
TODO: set $GOPATH
35+
# Check out sources
36+
git clone https://github.com/JonasProgrammer/docker-machine-driver-hetzner.git
37+
# Tell GO where to find sources and where to put binaries
38+
# see also https://github.com/golang/go/wiki/SettingGOPATH
39+
export GOPATH="$(pwd)"
40+
export GOBIN=$GOPATH/bin
41+
# Build the binary
42+
go get
43+
# Make the binary accessible to docker-machine
44+
export PATH="$PATH:$GOBIN"
45+
# Make docker-machine output help including hetzner-specific options
46+
docker-machine create --driver hetzner
5247

5348
## Usage
5449

55-
$ docker-machine create --driver hetzner --hetzner-api-token=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy some-machine
50+
$ docker-machine create \
51+
--driver hetzner \
52+
--hetzner-api-token=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy \
53+
some-machine
5654

5755
### Using environment variables
5856

59-
$ HETZNER_API_TOKEN=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy HETZNER_IMAGE=centos-7 docker-machine create --driver hetzner some-machine
57+
$ HETZNER_API_TOKEN=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy \
58+
&& HETZNER_IMAGE=centos-7 \
59+
&& docker-machine create \
60+
--driver hetzner \
61+
some-machine
6062

6163

6264
## Options

0 commit comments

Comments
 (0)