Merge pull request #2 from graphprotocol/rotarur/readme

updated README.md
added multi-platform support to pipeline
added branches filter for the pipeline to trigger only from main

.github/workflows/image.yml

@@ -5,6 +5,8 @@ on:
   push:
     tags:
       - v*.*.*
+    branches:
+      - main
   pull_request:
     branches: [main]
 
@@ -48,5 +50,6 @@ jobs:
           # Enabling the line below restricts Docker images to only be built for branches
           # push: ${{github.event_name != 'pull_request'}}
           push: true
+          platforms: linux/amd64,linux/arm64
           tags: ${{steps.docker_meta.outputs.tags}}
           labels: ${{steps.docker_meta.outputs.labels}}

README.md

@@ -54,9 +54,13 @@ QmfNueFQg19hyBtCRUPJRpxVtdwtp8cgWpuRoQpRP3n9st
 
 ## Docker
 
-- TO BE ADDED
+The easiest way is to use the built docker image
+
+```bash
+docker run -it ghcr.io/graphprotocol/ipfs-mgm sync --help
+```
 
 ## TODO:
 
-- [ ] Implement assync calls by creating a worker queue in batches
+- [ ] Implement async calls by creating a worker queue in batches
 - [ ] Add directory support for sync operation