Skip to content

Commit 4436ebf

Browse files
authored
docs(gateway): link to specs
1 parent eaea27b commit 4436ebf

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

gateway/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# IPFS Gateway
22

3-
> IPFS Gateway HTTP handler.
3+
> A reference implementation of HTTP Gateway Specifications.
44
55
## Documentation
66

77
* Go Documentation: https://pkg.go.dev/github.com/ipfs/go-libipfs/gateway
8-
8+
* Gateway Specification: https://github.com/ipfs/specs/tree/main/http-gateways#readme
9+
* Types of HTTP Gateways: https://docs.ipfs.tech/how-to/address-ipfs-on-web/#http-gateways
910
## Example
1011

1112
```go
@@ -23,13 +24,13 @@ conf := gateway.Config{
2324
ipfs := ...
2425
offlineIPFS := ...
2526

26-
// Create http mux and setup gateway handler.
27+
// Create http mux and setup path gateway handler.
2728
mux := http.NewServeMux()
2829
gwHandler := gateway.NewHandler(conf, ipfs, offlineIPFS)
2930
mux.Handle("/ipfs/", gwHandler)
3031
mux.Handle("/ipns/", gwHandler)
3132

32-
// Start the server on :8080 and voilá! You have an IPFS gateway running
33+
// Start the server on :8080 and voilá! You have a basic IPFS gateway running
3334
// in http://localhost:8080.
3435
_ = http.ListenAndServe(":8080", mux)
3536
```

0 commit comments

Comments
 (0)