From 450fd5a75089053286c0bad744e9503fbda0d670 Mon Sep 17 00:00:00 2001
From: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>
Date: Tue, 3 Oct 2023 21:54:42 -0600
Subject: [PATCH] =?UTF-8?q?fix:=20=F0=9F=91=B7=20Fixing=20CI=20+=20Readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>
---
 .github/workflows/docker.yml |  2 ++
 README.md                    | 36 +++++++++++++++++++++++++++++++++++-
 2 files changed, 37 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 0aca75d..a0800e6 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -26,6 +26,8 @@ jobs:
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
+        with:
+            platforms: linux/amd64
 
       - name: Docker meta
         id: meta
diff --git a/README.md b/README.md
index 5b2d6c9..90306bf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,35 @@
-# helia-docker
\ No newline at end of file
+# helia-docker
+
+Docker images for Helia.
+
+## Purpose
+
+This container image hosts helia in a node container. It implements [HTTP IPFS-gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types) and responds to the incoming requests using helia to fetch the content from IPFS.
+
+## Building
+
+```sh
+$ docker build . --tag helia
+```
+
+Pass the explicit platform when building on a Mac.
+
+```sh
+$ docker build . --tag helia --platform linux/arm64
+```
+
+Building with custom CMAKE flags.
+
+```sh
+$ docker build . --tag helia --build-arg CMAKE_CXX_FLAGS="..." --build-arg CMAKE_C_FLAGS="..."
+```
+
+## Running
+
+```sh
+$ docker run -it -p 8080:8080 helia
+```
+
+## Author
+
+- [whizzzkid](https://github.com/whizzzkid)