Просмотр исходного кода

Updates on the policies

tags/0.10^0
9seconds 7 лет назад
Родитель
Сommit
c1e5c33076
1 измененных файлов: 24 добавлений и 3 удалений
  1. 24
    3
      README.md

+ 24
- 3
README.md Просмотреть файл

@@ -50,6 +50,13 @@ To get promoted channel, please contact
50 50
 second parameter.
51 51
 
52 52
 
53
+# Source code organization
54
+
55
+There are 2 main branches:
56
+
57
+1. `master` branch contains potentially unstable features
58
+2. `stable` branch contains stable version. Usually you want to use this branch.
59
+
53 60
 # How to build
54 61
 
55 62
 ```console
@@ -70,8 +77,22 @@ $ make docker
70 77
 
71 78
 # Docker image
72 79
 
80
+Docker follows the same policy as the source code organization:
81
+
82
+- `latest` mirrors the master branch
83
+- `stable` mirrors the stable branch
84
+- tags are for tagged releases
85
+
86
+```console
87
+$ docker pull nineseconds/mtg:latest
88
+```
89
+
90
+```console
91
+$ docker pull nineseconds/mtg:stable
92
+```
93
+
73 94
 ```console
74
-$ docker pull nineseconds/mtg
95
+$ docker pull nineseconds/mtg:0.10
75 96
 ```
76 97
 
77 98
 # Configuration
@@ -130,13 +151,13 @@ This tool will listen on port 3128 by default with the given secret.
130 151
 # One-line runner
131 152
 
132 153
 ```console
133
-$ docker run --name mtg --restart=unless-stopped -p 3128:3128 -p 3129:3129 -d nineseconds/mtg $(openssl rand -hex 16)
154
+$ docker run --name mtg --restart=unless-stopped -p 3128:3128 -p 3129:3129 -d nineseconds/mtg:stable $(openssl rand -hex 16)
134 155
 ```
135 156
 
136 157
 or in secret mode:
137 158
 
138 159
 ```console
139
-$ docker run --name mtg --restart=unless-stopped -p 3128:3128 -p 3129:3129 -d nineseconds/mtg dd$(openssl rand -hex 16)
160
+$ docker run --name mtg --restart=unless-stopped -p 3128:3128 -p 3129:3129 -d nineseconds/mtg:stable dd$(openssl rand -hex 16)
140 161
 ```
141 162
 
142 163
 You will have this tool up and running on port 3128. Now curl

Загрузка…
Отмена
Сохранить