Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix link to doc from deno.land to jsr.io. #379

Merged
merged 4 commits into from
Sep 1, 2024
Merged

Fix link to doc from deno.land to jsr.io. #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
416c8a0
Fix jsr badge.
dajiaji Sep 1, 2024
2de9f9b
Change link to doc from deno.land to jsr.io.
dajiaji Sep 1, 2024
5314ee7
Remove deno doc badge.
dajiaji Sep 1, 2024
4237b65
Remove version info from README.
dajiaji Sep 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<h1 align="center">hpke-js</h1>

<div align="center">
<a href="https://jsr.io/@dajiaji/hpke"><img src="https://jsr.io/badges/@dajiaji/hpke" alt="JSR"/></a>
<a href="https://doc.deno.land/https/deno.land/x/hpke/mod.ts"><img src="https://doc.deno.land/badge.svg" alt="deno doc"/></a>
<a href="https://jsr.io/@hpke/hpke-js"><img src="https://jsr.io/badges/@hpke/hpke-js" alt="JSR"/></a>
<img src="https://github.com/dajiaji/hpke-js/actions/workflows/ci_browser.yml/badge.svg" alt="Browser CI" />
<img src="https://github.com/dajiaji/hpke-js/actions/workflows/ci_node.yml/badge.svg" alt="Node.js CI" />
<img src="https://github.com/dajiaji/hpke-js/actions/workflows/ci.yml/badge.svg" alt="Deno CI" />
Expand All @@ -23,8 +22,7 @@ This module works on web browsers, Node.js, Deno and various other JavaScript ru

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/mod.ts) |
Documentation: [jsr.io](https://jsr.io/@hpke/hpke-js/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/docs/)

</div>
Expand Down Expand Up @@ -264,8 +262,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/hpke-js@1.3.0";
// import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as hpke from "https://esm.sh/hpke-js@<SEMVER>";
// import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
// ...
</script>

Expand All @@ -282,8 +280,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/hpke-js@1.3.0/esm/mod.js";
// import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/hpke-js@<SEMVER>/esm/mod.js";
// import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -456,10 +454,10 @@ Browsers:
<head></head>
<body>
<script type="module">
import { AeadId, CipherSuite, KdfId, KemId } from "https://esm.sh/hpke-js@1.3.0";
import { AeadId, CipherSuite, KdfId, KemId } from "https://esm.sh/hpke-js@<SEMVER>";
// import {
// Aes128Gcm, CipherSuite, DhkemP256HkdfSha256, HkdfSha256,
// } from "https://esm.sh/@hpke/core@1.3.0";
// } from "https://esm.sh/@hpke/core@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
18 changes: 8 additions & 10 deletions x/chacha20poly1305/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Publ

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/x/chacha20poly1305/mod.ts)
|
Documentation: [jsr.io](https://jsr.io/@hpke/chacha20poly1305/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/chacha20poly1305/docs/)

</div>
Expand Down Expand Up @@ -86,8 +84,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as chacha20 from "https://esm.sh/@hpke/chacha20poly1305@1.3.0";
import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
import * as chacha20 from "https://esm.sh/@hpke/chacha20poly1305@<SEMVER>";
// ...
</script>

Expand All @@ -104,8 +102,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as chacha20 from "https://unpkg.com/@hpke/chacha20poly1305@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import * as chacha20 from "https://unpkg.com/@hpke/chacha20poly1305@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -216,11 +214,11 @@ try {
<head></head>
<body>
<script type="module">
// import * as hpke from "https://esm.sh/hpke-js@1.3.0";
// import * as hpke from "https://esm.sh/hpke-js@<SEMVER>";
import {
CipherSuite, DhkemP256HkdfSha256, HkdfSha256,
} from "https://esm.sh/@hpke/core@1.3.0";
import { Chacha20Poly1305 } from "https://esm.sh/@hpke/chacha20poly1305@1.3.0";
} from "https://esm.sh/@hpke/core@<SEMVER>";
import { Chacha20Poly1305 } from "https://esm.sh/@hpke/chacha20poly1305@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
11 changes: 5 additions & 6 deletions x/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Publ

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/core/mod.ts) |
Documentation: [jsr.io](https://jsr.io/@hpke/core/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/core/docs/)

</div>
Expand Down Expand Up @@ -88,7 +87,7 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
// ...
</script>

Expand All @@ -104,7 +103,7 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -225,10 +224,10 @@ try {
<head></head>
<body>
<script type="module">
// import * as hpke from "https://esm.sh/hpke-js@1.3.0";
// import * as hpke from "https://esm.sh/hpke-js@<SEMVER>";
import {
Aes128Gcm, CipherSuite, DhkemP256HkdfSha256, HkdfSha256,
} from "https://esm.sh/@hpke/core@1.3.0";
} from "https://esm.sh/@hpke/core@<SEMVER>";

globalThis.doHpke = async () => {

Expand Down
16 changes: 7 additions & 9 deletions x/dhkem-secp256k1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Publ

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/x/dhkem-secp256k1/mod.ts)
|
Documentation: [jsr.io](https://jsr.io/@hpke/dhkem-secp256k1/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/dhkem-secp256k1/docs/)

</div>
Expand Down Expand Up @@ -86,8 +84,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as secp256k1 from "https://esm.sh/@hpke/dhkem-secp256k1@1.3.0";
import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
import * as secp256k1 from "https://esm.sh/@hpke/dhkem-secp256k1@<SEMVER>";
// ...
</script>

Expand All @@ -104,8 +102,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as secp256k1 from "https://unpkg.com/@hpke/dhkem-secp256k1@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import * as secp256k1 from "https://unpkg.com/@hpke/dhkem-secp256k1@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -216,8 +214,8 @@ try {
<head></head>
<body>
<script type="module">
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core@1.3.0";
import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/dhkem-secp256k1@1.3.0";
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core@<SEMVER>";
import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/dhkem-secp256k1@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
16 changes: 7 additions & 9 deletions x/dhkem-x25519/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Publ

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/x/dhkem-x25519/mod.ts)
|
Documentation: [jsr.io](https://jsr.io/@hpke/dhkem-x25519/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/dhkem-x25519/docs/)

</div>
Expand Down Expand Up @@ -86,8 +84,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as x25519 from "https://esm.sh/@hpke/dhkem-x25519@1.3.0";
import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
import * as x25519 from "https://esm.sh/@hpke/dhkem-x25519@<SEMVER>";
// ...
</script>

Expand All @@ -104,8 +102,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as x25519 from "https://unpkg.com/@hpke/dhkem-x25519@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import * as x25519 from "https://unpkg.com/@hpke/dhkem-x25519@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -216,8 +214,8 @@ try {
<head></head>
<body>
<script type="module">
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core@1.3.0";
import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/dhkem-x25519@1.3.0";
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core@<SEMVER>";
import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/dhkem-x25519@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
16 changes: 7 additions & 9 deletions x/dhkem-x448/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Publ

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/x/dhkem-x448/mod.ts)
|
Documentation: [jsr.io](https://jsr.io/@hpke/dhkem-x448/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/dhkem-x448/docs/)

</div>
Expand Down Expand Up @@ -82,8 +80,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as x448 from "https://esm.sh/@hpke/dhkem-x448@1.3.0";
import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
import * as x448 from "https://esm.sh/@hpke/dhkem-x448@<SEMVER>";
// ...
</script>

Expand All @@ -100,8 +98,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as x448 from "https://unpkg.com/@hpke/dhkem-x448@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import * as x448 from "https://unpkg.com/@hpke/dhkem-x448@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -212,8 +210,8 @@ try {
<head></head>
<body>
<script type="module">
import { Aes256Gcm, CipherSuite, HkdfSha512 } from "https://esm.sh/@hpke/core@1.3.0";
import { DhkemX448HkdfSha512 } from "https://esm.sh/@hpke/dhkem-x448@1.3.0";
import { Aes256Gcm, CipherSuite, HkdfSha512 } from "https://esm.sh/@hpke/core@<SEMVER>";
import { DhkemX448HkdfSha512 } from "https://esm.sh/@hpke/dhkem-x448@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
18 changes: 8 additions & 10 deletions x/hpke-js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<h1 align="center">hpke-js</h1>

<div align="center">
<a href="https://jsr.io/@dajiaji/hpke"><img src="https://jsr.io/badges/@dajiaji/hpke" alt="JSR"/></a>
<a href="https://doc.deno.land/https/deno.land/x/hpke/mod.ts"><img src="https://doc.deno.land/badge.svg" alt="deno doc"/></a>
<a href="https://jsr.io/@hpke/hpke-js"><img src="https://jsr.io/badges/@hpke/hpke-js" alt="JSR"/></a>
<img src="https://github.com/dajiaji/hpke-js/actions/workflows/ci_browser.yml/badge.svg" alt="Browser CI" />
<img src="https://github.com/dajiaji/hpke-js/actions/workflows/ci_node.yml/badge.svg" alt="Node.js CI" />
<img src="https://github.com/dajiaji/hpke-js/actions/workflows/ci.yml/badge.svg" alt="Deno CI" />
Expand All @@ -23,8 +22,7 @@ This module works on web browsers, Node.js, Deno and various other JavaScript ru

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/mod.ts) |
Documentation: [jsr.io](https://jsr.io/@hpke/hpke-js/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/docs/)

</div>
Expand Down Expand Up @@ -260,8 +258,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/hpke-js@1.3.0";
// import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as hpke from "https://esm.sh/hpke-js@<SEMVER>";
// import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
// ...
</script>

Expand All @@ -278,8 +276,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/hpke-js@1.3.0/esm/mod.js";
// import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/hpke-js@<SEMVER>/esm/mod.js";
// import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -450,10 +448,10 @@ Browsers:
<head></head>
<body>
<script type="module">
import { AeadId, CipherSuite, KdfId, KemId } from "https://esm.sh/hpke-js@1.3.0";
import { AeadId, CipherSuite, KdfId, KemId } from "https://esm.sh/hpke-js@<SEMVER>";
// import {
// Aes128Gcm, CipherSuite, DhkemP256HkdfSha256, HkdfSha256,
// } from "https://esm.sh/@hpke/core@1.3.0";
// } from "https://esm.sh/@hpke/core@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
16 changes: 7 additions & 9 deletions x/hybridkem-x25519-kyber768/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ A TypeScript <a href="https://datatracker.ietf.org/doc/html/rfc9180">Hybrid Publ

<div align="center">

Documentation:
[deno.land](https://doc.deno.land/https://deno.land/x/hpke/x/hybridkem-x25519-kyber768/mod.ts)
|
Documentation: [jsr.io](https://jsr.io/@hpke/hybridkem-x25519-kyber768/doc) |
[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/hybridkem-x25519-kyber768/docs/)

</div>
Expand Down Expand Up @@ -89,8 +87,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/core@1.3.0";
import * as kyber from "https://esm.sh/@hpke/hybridkem-x25519-kyber768@1.3.0";
import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
import * as kyber from "https://esm.sh/@hpke/hybridkem-x25519-kyber768@<SEMVER>";
// ...
</script>

Expand All @@ -107,8 +105,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/core@1.3.0/esm/mod.js";
import * as kyber from "https://unpkg.com/@hpke/hybridkem-x25519-kyber768@1.3.0/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
import * as kyber from "https://unpkg.com/@hpke/hybridkem-x25519-kyber768@<SEMVER>/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -219,8 +217,8 @@ try {
<head></head>
<body>
<script type="module">
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core@1.3.0";
import { HybridkemX25519Kyber768 } from "https://esm.sh/@hpke/hybridkem-x25519-kyber768@1.3.0";
import { Aes128Gcm, CipherSuite, HkdfSha256 } from "https://esm.sh/@hpke/core@<SEMVER>";
import { HybridkemX25519Kyber768 } from "https://esm.sh/@hpke/hybridkem-x25519-kyber768@<SEMVER>";

globalThis.doHpke = async () => {
try {
Expand Down
Loading