diff --git a/README.md b/README.md index 4e13115..19f921f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,33 @@ # Portal [![GitHub & Docker Artifacts](https://github.com/Torben-Tom/Portal/actions/workflows/main.yml/badge.svg)](https://github.com/Torben-Tom/Portal/actions/workflows/main.yml) + A web-based 2D clone of Valve's famous puzzle game Portal ## Pipeline Status + ### Stable build + [![GitHub & Docker Artifacts](https://github.com/Torben-Tom/Portal/actions/workflows/main.yml/badge.svg)](https://github.com/Torben-Tom/Portal/actions/workflows/main.yml) + ### Beta build + [![Build and deploy release](https://github.com/Torben-Tom/Portal/actions/workflows/staging.yml/badge.svg)](https://github.com/Torben-Tom/Portal/actions/workflows/staging.yml) ## Installation + ### Docker -1. Run ```docker run --rm -p PORT:80 -d torbentom/portal:latest``` + +1. Run `docker run --rm -p PORT:80 -d torbentom/portal:latest` 2. Navigate to http://localhost:PORT + ### Manual + 1. Navigate to [Releases](https://github.com/Torben-Tom/Portal/releases) 2. Download release 3. Drop files into a web server like nginx or apache 4. Connect to your web server + +## Credits + +https://www.patreon.com/posts/27430241 +https://craftpix.net/file-licenses/ +https://www.pixilart.com/terms