Skip to content

Commit 95e5954

Browse files
committed
Update project's README
1 parent 3810f62 commit 95e5954

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

Diff for: README.md

+26-19
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,11 @@ We look forward to your contributions!
2727

2828
## Versions
2929

30-
The latest development points towards a Wegue version v2. This development is reflected within the `master` branch.
31-
Herewith some breaking changes come along. In case you have to remain on the v1.x version of Wegue you can use the latest release [v1.2.1](https://github.com/wegue-oss/wegue/releases/tag/v1.2.1) or to the maintenance development of v1 in the [v1 branch](https://github.com/wegue-oss/wegue/tree/v1). For a reasonable amount of time `v1` branch will be maintained. At least until there is an official `v2` release plus some additional buffer time.
30+
The lastest stable and released stream is version 2.x.
31+
32+
The latest developments are reflected within the `master` branch. We always try to have a robust state at the `master` branch, but be aware that breaking changes could come along.
33+
34+
In case you have to remain on the v1.x version of Wegue you can use the latest release [v1.2.1](https://github.com/wegue-oss/wegue/releases/tag/v1.2.1) or to the maintenance development of v1 in the [v1 branch](https://github.com/wegue-oss/wegue/tree/v1). For a reasonable amount of time `v1` branch will be maintained.
3235

3336
In case you want to upgrade an existing Wegue app from v1 to the current v2 development stream please have a look at the `upgrade-notes.md` file.
3437

@@ -120,41 +123,45 @@ Besides the environment variables supported by Vue CLI Wegue offers the followin
120123

121124
## Run with Docker
122125

123-
Versioned Docker images are available on [DockerHub](https://hub.docker.com/r/meggsimum/wegue/tags).
124-
Run the `latest` (`master`) version of the Wegue Docker Image as follows:
126+
The shipped Dockerfile gives you a basic idea how to use Wegue with Docker.
127+
Maybe the Dockerfile needs some modification if you use custom application code.
128+
Once you get along with just modifying the application config JSON it should be sufficient to do the following steps:
129+
130+
Build a Wegue Docker image as follows:
131+
132+
``` bash
133+
docker build -t my-wegue-img:latest .
134+
```
135+
136+
Start the freshly build image as container:
125137

126138
``` bash
127-
docker run -it -p 8080:80 meggsimum/wegue:latest
139+
docker run -it -p 8080:80 my-wegue-img:latest
128140
```
129141

130142
Open
131-
- http://127.0.0.1:8080/ or
132-
- http://localhost:8080/?appCtx=minimal or
133-
- http://localhost:8080/?appCtx=projected
143+
144+
- <http://127.0.0.1:8080/> or
145+
- <http://localhost:8080/?appCtx=minimal> or
146+
- <http://localhost:8080/?appCtx=projected>
134147

135148
in a browser.
136149

137-
Use Docker Volume Mapping to run with your custom Wegue JSON config:
150+
Use Docker Volume mapping to run with your custom Wegue JSON config:
138151

139152
``` bash
140-
docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf-mine.json meggsimum/wegue:latest
153+
docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf-mine.json my-wegue-img:latest
141154
```
142155

143-
and open http://localhost:8080/?appCtx=mine.
156+
and open <http://localhost:8080/?appCtx=mine>.
144157

145158
You can even overwrite the default config `app-conf.json`:
146159

147160
``` bash
148-
docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf.json meggsimum/wegue:latest
161+
docker run -it -p 8080:80 -v $(pwd)/app-conf-mine.json:/usr/share/nginx/html/static/app-conf.json my-wegue-img:latest
149162
```
150163

151-
and then open http://localhost:8080/.
152-
153-
Build a Wegue Docker Image as follows:
154-
155-
``` bash
156-
docker build -t meggsimum/wegue:latest .
157-
```
164+
and then open <http://localhost:8080/>.
158165

159166
## Developing online using Gitpod.io
160167

0 commit comments

Comments
 (0)