Browse Source

Add installation instructions to README

pull/2/head
Chris Smith 7 years ago
parent
commit
d4ed1d0887
1 changed files with 9 additions and 3 deletions
  1. 9
    3
      README.md

+ 9
- 3
README.md View File

12
 Want to update to a newer image, or add a missing port publication?
12
 Want to update to a newer image, or add a missing port publication?
13
 docker-rerun's got you covered.
13
 docker-rerun's got you covered.
14
 
14
 
15
+## Installation
16
+
17
+You can install the latest version of docker-rerun using pip:
18
+
19
+    $ pip install docker-rerun
20
+
15
 ## Usage
21
 ## Usage
16
 
22
 
17
 In the most basic usage, you pass in a container name and it will be
23
 In the most basic usage, you pass in a container name and it will be
18
 stopped, deleted and recreated:
24
 stopped, deleted and recreated:
19
 
25
 
20
-    $ ./docker-rerun apache
26
+    $ docker-rerun apache
21
 
27
 
22
 You can also pass additional arguments to modify aspects of the container
28
 You can also pass additional arguments to modify aspects of the container
23
 when it's rerun. For example, to change the image:
29
 when it's rerun. For example, to change the image:
24
 
30
 
25
-    $ ./docker-rerun --image nginx:latest webserver
31
+    $ docker-rerun --image nginx:latest webserver
26
 
32
 
27
 To check what exactly is going to be performed beforehand, use the --dry-run
33
 To check what exactly is going to be performed beforehand, use the --dry-run
28
 option:
34
 option:
29
 
35
 
30
-    $ ./docker-rerun --dry-run apache
36
+    $ docker-rerun --dry-run apache
31
     docker stop apache
37
     docker stop apache
32
     docker rm apache
38
     docker rm apache
33
     docker run --name=apache -p=80:80/tcp --restart=always apache:latest
39
     docker run --name=apache -p=80:80/tcp --restart=always apache:latest

Loading…
Cancel
Save