Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update Knox Test suite instructions
  • Loading branch information
fkim7 authored Jul 31, 2023
1 parent 0a186fb commit 5cb149a
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ There are three types of implementations that this test suite tests:
DID Methods, DID Resolvers, and DID URL Dereferencers. In order to add
your implementation to this test suite:

1. Add your input file(s) to the [implementations](https://github.com/w3c/did-test-suite/tree/main/packages/did-core-test-server/suites/implementations) directory. For an example, see the [example DID Method implementation](https://github.com/w3c/did-test-suite/blob/main/packages/did-core-test-server/suites/implementations/did-example-didwg.json) (or any other file that looks closest to your implementation in the directory). **For Knox- **https://github.com/knox-networks/did-test-suite/blob/main/packages/did-core-test-server/suites/implementations/did-knox.json
1. Add your input file(s) to the [implementations](https://github.com/w3c/did-test-suite/tree/main/packages/did-core-test-server/suites/implementations) directory. For an example, see the [example DID Method implementation](https://github.com/w3c/did-test-suite/blob/main/packages/did-core-test-server/suites/implementations/did-example-didwg.json) (or any other file that looks closest to your implementation in the directory).

**For Knox- **https://github.com/knox-networks/did-test-suite/blob/main/packages/did-core-test-server/suites/implementations/did-knox.json
Upon merge, test results will be updated automatically on https://knox-networks.github.io/did-test-suite/
Or this can be triggered via GHA https://github.com/knox-networks/did-test-suite/actions/workflows/ci-deploy-pages.yml

2. Add your input file to all relevant `default.js` test suite configurations. For example, DID Methods should add themselves to the did-identifier, did-core-properties, did-production, and did-consumption suites. Resolver implementations should only be added to the did-resolution test suite. See the [current list of implementations listed for did-core-properties](https://github.com/w3c/did-test-suite/blob/main/packages/did-core-test-server/suites/did-core-properties/default.js) for more information. Implementers might want to peruse the [list of all the test suites](https://github.com/w3c/did-test-suite/tree/main/packages/did-core-test-server/suites) for more detail.
3. Run the test suite and make sure your implementation passes.
4. Submit a pull request on this repository to add your implementation.
Expand Down

0 comments on commit 5cb149a

Please sign in to comment.