Skip to content

Commit a3c8546

Browse files
committed
updated README
1 parent 28ae7b3 commit a3c8546

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# PaperMC Server Docker Image
22

3-
![Build Status](https://img.shields.io/github/actions/workflow/status/c3kay/paper-docker/build.yml)
4-
![MC Version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fc3kay%2Fpaper-docker%2Fmaster%2F.github%2Fworkflows%2Fbuild.yml&query=%24.jobs.build.env.MC_VERSION&label=minecraft)
5-
6-
This is a simple docker image for a Minecraft PaperMC Server running on Amazon Corretto.
3+
A simple docker image for a Minecraft PaperMC Server running on Amazon Corretto.
4+
The image is build and updated weekly with the latest stable version of PaperMC.
75

86
## Installation
97

108
```sh
119
docker pull ghcr.io/c3kay/paper-docker:<mc-version>
1210
```
1311

14-
*Also see the example `compose.yml` file.*
12+
Check the [Packages page](https://github.com/c3kay/paper-docker/pkgs/container/paper-docker) for available versions.
13+
Also see the example `compose.yml` file.
1514

1615
## Configuration & Usage
1716

1817
All data and configs are located in the `/opt/minecraft/data` folder.
1918
You can map a docker volume or local directory to persist this folder.
2019

2120
The following environment variables can be set:
21+
2222
- `PUID`: The UID of the user running the server (default: `1000`).
2323
- `MEM_SIZE`: Allocated memory for the server.
2424
- `PAPERMC_FLAGS`: Additional flags for PaperMC.

0 commit comments

Comments
 (0)