From e670dcbe22e8bb4346f3fdfad008e54f39d814fb Mon Sep 17 00:00:00 2001 From: Alexander Loren Date: Mon, 24 Aug 2026 20:03:21 -0700 Subject: [PATCH] Updated README --- README.md | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 00dc3f5..3e28371 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,41 @@ -# Swift + Node.js Docker Image +# Swift CI -A minimal CI image based on the official Swift Docker image. +A small Docker image for running Swift CI workflows with Node.js support. -Currently mirrors **Swift 6.3.3** and adds **Node.js 24 LTS** for CI workflows that require Node.js, such as repository checkout actions. \ No newline at end of file +The image is based on the official Swift Docker image and adds Node.js 24 LTS for CI tools and actions that require it, such as repository checkout actions. + +## Included + +- Swift 6.3.3 +- Node.js 24 LTS +- Git +- cURL +- CA certificates + +## Usage + +Use the image as the container for a CI job: + +```yaml +jobs: + build: + runs-on: docker_runner + container: + image: git.omgitsalexl.me/omgitsalexl/ci-swift:latest + + steps: + - uses: actions/checkout@v4 + + - name: Build + run: swift build -c release +``` + +You can also use it directly with Docker: + +```bash +docker run --rm -it git.omgitsalexl.me/omgitsalexl/ci-swift:latest swift --version +``` + +## Purpose + +The official Swift image does not include Node.js. This image adds it so Node-based CI actions can run while keeping the rest of the environment close to the standard Swift container. \ No newline at end of file