docs: update docs to mention the available docker-image

speakeasy-api · Jul 5, 2023 · d4eb498 · d4eb498
1 parent 561ff6f
commit d4eb498
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -87,13 +87,15 @@ SPEAKEASY_API_KEY='{API_KEY_HERE}' ./speakeasy-proxy
 
 ### Run Docker Image
 
-If built locally:
+If using our pre-built image first pull the required image:
 
 ```bash
-docker run --network="host" -p 3333:3333 -v $(pwd)/config.yaml:/config.yaml -v $(pwd)/httpbin.yaml:/httpbin.yaml -e SPEAKEASY_API_KEY='{API_KEY_HERE}' speakeasy-proxy
+docker pull ghcr.io/speakeasy-api/speakeasy-proxy:latest
 ```
 
-If using our pre-built image:
+otherwise build the image yourself (see [Building](#building) for details).
+
+Then run the image:
 
 ```bash
-```
+docker run --network="host" -p 3333:3333 -v $(pwd)/config.yaml:/config.yaml -v $(pwd)/httpbin.yaml:/httpbin.yaml -e SPEAKEASY_API_KEY='{API_KEY_HERE}' speakeasy-proxy