fix: gateway readme (#31)

* fix: gateway readme * defaults
n0-computer · May 10, 2022 · e94a7e0 · e94a7e0
1 parent b1c49a1
commit e94a7e0
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/iroh-gateway/README.md b/iroh-gateway/README.md
@@ -16,3 +16,11 @@ A rust implementation of an IPFS gateway.
 
 - `IROH_INSTANCE_ID` - unique instance identifier, preferably some name than hard id (default: generated lower & snake case name)
 - `IROH_ENV` - indicates the service environment (default: `dev`)
+
+## Endpoints
+
+| Endpoint                          | Flag                                       | Description                                                                             | Default    |
+|-----------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------|------------|
+| `/ipfs/:cid` & `/ipfs/:cid/:path` | `?format={"", "fs", "raw", "car", "html"}` | Specifies the serving format & content-type                                             | `""/fs`    |
+|                                   | `?filename=DESIRED_FILE_NAME`              | Specifies a filename for the attachment                                                 | `{cid}.bin` |
+|                                   | `?download={true, false}`                  | Sets content-disposition to attachment, browser prompts to save file instead of loading | `false`    |