Skip to content

Commit 71743e4

Browse files
authored
docs(readme): link to gateway specs
1 parent d081741 commit 71743e4

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
# gateway-conformance
22

3-
`gateway-conformance` is a tool designed to test if an IPFS Gateway implementation complies with the IPFS Gateway Specification correctly. The tool is distributed as a Docker image, as well as a GitHub Action(s).
4-
5-
[![Conformance Production Dashboard](https://github.com/ipfs/gateway-conformance/actions/workflows/test-prod-e2e.yml/badge.svg?branch=master)]()
6-
7-
## Table of Contents
3+
> A tool designed to test if an IPFS Gateway implementation complies with the [IPFS Gateway Specification](https://specs.ipfs.tech/http-gateways/) correctly.
4+
> Distributed as a Docker image, as well as a GitHub Action(s).
85
96
- [Commands](#commands)
10-
- [test](#test)
7+
- [`test`](#test)
118
- [Inputs](#inputs)
129
- [Subdomain Testing and `subdomain-url`](#subdomain-testing-and-subdomain-url)
1310
- [Usage](#usage)
14-
- [extract-fixtures](#extract-fixtures)
11+
- [`extract-fixtures`](#extract-fixtures)
1512
- [Inputs](#inputs-1)
1613
- [Outputs](#outputs)
1714
- [Usage](#usage-1)
@@ -27,7 +24,7 @@
2724

2825
### test
2926

30-
The `test` command is the main command of the tool. It is used to test a given IPFS Gateway implementation against the IPFS Gateway Specification.
27+
The `test` command is the main command of the tool. It is used to test a given IPFS Gateway implementation against the [IPFS Gateway Specification](https://specs.ipfs.tech/http-gateways/).
3128

3229
#### Inputs
3330

@@ -317,4 +314,4 @@ Please let us know if you would like to see this feature implemented directly in
317314
- How to deal with subdomains & configuration (t0114 for example)?
318315
- Some test relies on querying URLs like `http://$CIDv1.ipfs.example.com/`. While `http://$CIDv1.ipfs.localhost/` works by default, do we need / want to test with `.example.com`?
319316
- Debug logging
320-
- Set the environment variable `GOLOG_LOG_LEVEL="conformance=debug"` to toggle debug logging.
317+
- Set the environment variable `GOLOG_LOG_LEVEL="conformance=debug"` to toggle debug logging.

0 commit comments

Comments
 (0)