Skip to content

Commit 5477f1f

Browse files
committedMar 7, 2017
Update readme
* Send people to the new doc site * Contributing guide
1 parent ddb1645 commit 5477f1f

File tree

3 files changed

+38
-101
lines changed

3 files changed

+38
-101
lines changed
 

‎CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
1. Clone this repository
4+
5+
```
6+
go get -d github.com/howtowhale/dvm
7+
cd $GOPATH/src/github.com/howtowhale/dvm
8+
```
9+
10+
1. Add your fork as a remote:
11+
12+
```
13+
git remote add fork git@github.com:USERNAME/dvm.git
14+
```
15+
16+
1. Build `dvm`:
17+
18+
```
19+
make
20+
```
21+
22+
1. Run tests:
23+
24+
```
25+
make test
26+
```
27+
28+
1. Try out your local build:
29+
30+
```
31+
source ./dvm.sh
32+
dvm --version
33+
```

‎ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ $ dvm --version
2121
[PASTE YOUR OUTPUT HERE]
2222
```
2323

24-
What is your operating System?
24+
What is your Operating System?
2525

2626
What is your shell (bash/powershell/cmd/fish)?
2727

‎README.md

+4-100
Original file line numberDiff line numberDiff line change
@@ -2,111 +2,15 @@
22

33
[![Build Status](https://travis-ci.org/getcarina/dvm.svg?branch=master)](https://travis-ci.org/getcarina/dvm)
44

5-
Version management for your Docker clients. Heavily influenced by [nvm](https://github.com/creationix/nvm) (ok, "borrowed" from).
6-
This tool modifies your current PATH to switch between different Docker clients.
5+
<p style="text-align: center"><a href="https://howtowhale.github.io/dvm/">howtowhale.github.io/dvm/</a></p>
76

87
![dvm-usage](https://cloud.githubusercontent.com/assets/1368985/10800443/d3f0f39a-7d7f-11e5-87b5-1bda5ffe4859.png)
98

10-
Escape from this error for a little bit longer:
9+
Version management for your Docker client. Escape from this error for a little bit longer:
1110

1211
```
1312
Error response from daemon: client and server don't have same version (client : 1.18, server: 1.16)
1413
```
1514

16-
## Prerequisites
17-
* Mac OS X and Linux: curl/wget or homebrew.
18-
* Windows: PowerShell v4+
19-
20-
## Installation
21-
1. Run the one of the installation scripts below.
22-
2. Copy, paste and run the commands from the installation output to finalize the installation.
23-
24-
**Mac OS X with Homebrew**
25-
26-
```bash
27-
$ brew update && brew install dvm
28-
```
29-
30-
**Mac OS X without Homebrew, and Linux**
31-
32-
```bash
33-
$ curl -sL https://download.getcarina.com/dvm/latest/install.sh | sh
34-
```
35-
36-
**Windows**
37-
38-
Open a PowerShell command prompt and execute the following command. We use PowerShell 4 to do the initial
39-
installation but you can use `dvm` with PowerShell or CMD once it's installed.
40-
41-
```powershell
42-
> Invoke-WebRequest https://download.getcarina.com/dvm/latest/install.ps1 -UseBasicParsing | Invoke-Expression
43-
```
44-
45-
**Note**: If you use zsh instead of bash, add `source $HOME/.dvm/dvm.sh` to your `~/.zshrc` to finalize the installation.
46-
47-
## Upgrading from previous dvm
48-
**Mac OS X with Homebrew**
49-
50-
Homebrew users should use `brew upgrade dvm` to get the latest version, as `dvm upgrade` is disabled in homebrew builds.
51-
52-
**Mac OS X without Homebrew, Linux, and Windows**
53-
If you have dvm 0.2 or later, run `dvm upgrade` to install the latest version of dvm.
54-
55-
**Note**: If you have dvm 0.0.0, then you will need to reinstall. `dvm` used to *only* be only one shell script, relying on a git backed `~/.dvm`. This worked well for \*nix users and was not workable for Windows users. We've since switched over to small wrapper scripts and a go binary called `dvm-helper` to make cross platform simple and easy. To upgrade, you can either pull and rebuild yourself (with a working go setup), or use the install script. You'll need to open up a new terminal to ensure that all the `dvm` functions are set properly.
56-
57-
## Usage
58-
59-
To install the 1.8.2 release of docker, do this:
60-
61-
dvm install 1.8.2
62-
63-
Now in any new shell use the installed version:
64-
65-
dvm use 1.8.2
66-
67-
If you want to see what versions are installed:
68-
69-
dvm ls
70-
71-
If you want to see what versions are available to install:
72-
73-
dvm ls-remote
74-
75-
To restore your PATH, you can deactivate it:
76-
77-
dvm deactivate
78-
79-
## Bash and zsh completion
80-
81-
There is bash and zsh completion available in `$DVM_DIR/bash_completion`. To invoke it into your shell, run
82-
83-
```bash
84-
[[ -r $DVM_DIR/bash_completion ]] && . $DVM_DIR/bash_completion
85-
```
86-
87-
For zsh, there's a bit of special sauce using `bashcompinit` from the more recent versions of zsh.
88-
89-
### Usage
90-
91-
```
92-
$ dvm [TAB]
93-
alias install ls uninstall which
94-
current list ls-alias unload
95-
deactivate list-alias ls-remote use
96-
help list-remote unalias version
97-
$ dvm u[TAB]
98-
unalias uninstall unload use
99-
$ dvm us[TAB]
100-
$ dvm use [TAB]
101-
1.8.2 1.9.0 carina default experimental
102-
```
103-
## Mirroring docker builds
104-
105-
You may want to use a local mirror for Docker binaries instead of downloading them from the default site (`https://get.docker.com/builds`). There are a few possible reasons for this, most commonly the need to avoid dealing with corporate proxies every time.
106-
107-
The environment variable DVM_MIRROR_URL can be set to a local mirror inside your LAN:
108-
109-
```
110-
export DVM_MIRROR_URL="http://localserver/docker/builds"
111-
dvm install 1.10.3
112-
```
15+
# Contributing
16+
See our [Contributing Guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)
Please sign in to comment.