Skip to content

Commit a779486

Browse files
committed
chore: update example links in README.md
1 parent d4f7bf1 commit a779486

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Support from the community to continue maintaining and improving this module is
1010

1111
`@panva/hpke` has no dependencies and it exports tree-shakeable ESM.
1212

13-
## [API Reference](/docs/README.md)
13+
## [API Reference](docs/README.md)
1414

1515
`@panva/hpke` is distributed via [npmjs.com](https://www.npmjs.com/package/@panva/hpke), [jsdelivr.com](https://www.jsdelivr.com/package/npm/@panva/hpke), and [github.com](https://github.com/panva/hpke).
1616

@@ -38,9 +38,9 @@ const decrypted = await suite.Open(recipient.privateKey, encapsulatedKey, cipher
3838
console.log(new TextDecoder().decode(decrypted)) // "Hello, World!"
3939
```
4040

41-
## [Examples](/examples/README.md)
41+
## [Examples](examples/README.md)
4242

43-
For more advanced examples, including how to integrate external cryptographic libraries, see the [examples directory](/examples/README.md).
43+
For more advanced examples, including how to integrate external cryptographic libraries, see the [examples directory](examples/README.md).
4444

4545
## Supported Runtimes
4646

@@ -61,7 +61,7 @@ Please note that some suites may not be available depending on the runtime used.
6161

6262
Algorithm implementations exposed by this module are built on top of [Web Cryptography][] (and its extensions, e.g. [Secure Curves][], [Modern Algorithms][]). Runtimes implementing Web Cryptography are not required to support all of its algorithms and so not all algorithms are available in all runtimes.
6363

64-
This module is designed to be extensible, you can bring outside-built implementations of any KEM, KDF, or AEAD algorithm into any runtime by conforming to the respective interfaces ([KEM](/docs/interfaces/KEM.md), [KDF](/docs/interfaces/KDF.md), [AEAD](/docs/interfaces/AEAD.md)). This allows you to use alternative cryptographic libraries, native bindings, or specialized hardware implementations alongside the built-in Web Cryptography-based algorithms. See the [Noble Suite Example](./examples/noble-suite/README.md) for a demonstration of integrating external cryptographic libraries. Below are the algorithms built in (based on Web Cryptography) and their runtime support matrix.
64+
This module is designed to be extensible, you can bring outside-built implementations of any KEM, KDF, or AEAD algorithm into any runtime by conforming to the respective interfaces ([KEM](docs/interfaces/KEM.md), [KDF](docs/interfaces/KDF.md), [AEAD](docs/interfaces/AEAD.md)). This allows you to use alternative cryptographic libraries, native bindings, or specialized hardware implementations alongside the built-in Web Cryptography-based algorithms. See the [Noble Suite Example](examples/noble-suite/README.md) for a demonstration of integrating external cryptographic libraries. Below are the algorithms built in (based on Web Cryptography) and their runtime support matrix.
6565

6666
### KEM
6767

@@ -125,4 +125,4 @@ The algorithm implementations in `@panva/hpke` have been tested using test vecto
125125

126126
[^24.7]: Available in Node.js versions >= 24.7.0
127127

128-
[^noble]: Available through [extensibility](./examples/noble-suite/README.md)
128+
[^noble]: Available through extensibility

0 commit comments

Comments
 (0)