diff --git a/.github/workflows/ci_browser.yml b/.github/workflows/ci_browser.yml index b309e234c..52a3ee385 100644 --- a/.github/workflows/ci_browser.yml +++ b/.github/workflows/ci_browser.yml @@ -48,22 +48,22 @@ jobs: deno task minify > ../test/runtimes/browsers/pages/dhkem-secp256k1/src/hpke-core.js - working-directory: ./x/dhkem-x25519 run: | - npx typedoc --name "@hpke/dhkem-x25519 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../test/runtimes/browsers/pages/dhkem-x25519/docs mod.ts + npx typedoc --name "@hpke/dhkem-x25519 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../../test/runtimes/browsers/pages/dhkem-x25519/docs mod.ts deno task dnt deno task minify > ../../test/runtimes/browsers/pages/dhkem-x25519/src/hpke-dhkem-x25519.js - working-directory: ./x/dhkem-x448 run: | - npx typedoc --name "@hpke/dhkem-x448 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../test/runtimes/browsers/pages/dhkem-x448/docs mod.ts + npx typedoc --name "@hpke/dhkem-x448 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../../test/runtimes/browsers/pages/dhkem-x448/docs mod.ts deno task dnt deno task minify > ../../test/runtimes/browsers/pages/dhkem-x448/src/hpke-dhkem-x448.js - working-directory: ./x/chacha20poly1305 run: | - npx typedoc --name "@hpke/chacha20poly1305 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../test/runtimes/browsers/pages/chacha20poly1305/docs mod.ts + npx typedoc --name "@hpke/chacha20poly1305 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../../test/runtimes/browsers/pages/chacha20poly1305/docs mod.ts deno task dnt deno task minify > ../../test/runtimes/browsers/pages/chacha20poly1305/src/hpke-chacha20poly1305.js - working-directory: ./x/dhkem-secp256k1 run: | - npx typedoc --name "@hpke/dhkem-secp256k1 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../test/runtimes/browsers/pages/dhkem-secp256k1/docs mod.ts + npx typedoc --name "@hpke/dhkem-secp256k1 $(git describe --tags $(git rev-list --tags --max-count=1))" --out ../../test/runtimes/browsers/pages/dhkem-secp256k1/docs mod.ts deno task dnt deno task minify > ../../test/runtimes/browsers/pages/dhkem-secp256k1/src/hpke-dhkem-secp256k1.js - uses: peaceiris/actions-gh-pages@v3 diff --git a/CHANGES.md b/CHANGES.md index ed3b312d7..5d9058fc0 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,12 @@ # Changes +## Version 1.0.1 + +Released 2023-08-06 + +- [(#226) Remove unnecessary ciphersuite classes.](https://github.com/dajiaji/hpke-js/pull/226) +- [(#225) Deploy tsdoc-based document to pages.](https://github.com/dajiaji/hpke-js/pull/225) + ## Version 1.0.0 Released 2023-08-05 diff --git a/README.md b/README.md index a9260d5bc..818b9446a 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ This module works on web browsers, Node.js, Deno and various other JavaScript ru
-[Documentation](https://doc.deno.land/https://deno.land/x/hpke/mod.ts) +[Doc(deno.land)](https://doc.deno.land/https://deno.land/x/hpke/mod.ts)/[Doc(pages, only for the latest version)](https://dajiaji.github.io/hpke-js/docs/)
@@ -181,8 +181,8 @@ Using esm.sh: ```html @@ -199,8 +199,8 @@ Using unpkg: ```html ``` @@ -237,9 +237,9 @@ Using deno.land: ```js // use a specific version -import * as hpke from "https://deno.land/x/hpke@1.0.0/core/mod.ts"; -// import * as hpke from "https://deno.land/x/hpke@1.0.0/x/dhkem-x25519/mod.ts"; -// import * as hpke from "https://deno.land/x/hpke@1.0.0/mod.ts"; +import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts"; +// import * as hpke from "https://deno.land/x/hpke@1.0.1/x/dhkem-x25519/mod.ts"; +// import * as hpke from "https://deno.land/x/hpke@1.0.1/mod.ts"; // use the latest stable version import * as hpke from "https://deno.land/x/hpke/core/mod.ts"; @@ -283,8 +283,8 @@ Browsers: @@ -47,8 +47,8 @@ Using unpkg: ```html ``` @@ -73,7 +73,7 @@ Using deno.land: ```js // use a specific version -import * as hpke from "https://deno.land/x/hpke@1.0.0/core/mod.ts"; +import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts"; // use the latest stable version import * as hpke from "https://deno.land/x/hpke/core/mod.ts"; @@ -100,8 +100,8 @@ This section shows some typical usage examples. @@ -49,8 +49,8 @@ Using unpkg: ```html ``` @@ -75,8 +75,8 @@ Using deno.land: ```js // use a specific version -import * as hpke from "https://deno.land/x/hpke@1.0.0/core/mod.ts"; -import * as chacha20 from "https://deno.land/x/hpke@1.0.0/x/chacha20poly1305/mod.ts"; +import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts"; +import * as chacha20 from "https://deno.land/x/hpke@1.0.1/x/chacha20poly1305/mod.ts"; // use the latest stable version import * as hpke from "https://deno.land/x/hpke/core/mod.ts"; @@ -104,9 +104,9 @@ This section shows some typical usage examples. @@ -49,8 +49,8 @@ Using unpkg: ```html ``` @@ -75,8 +75,8 @@ Using deno.land: ```js // use a specific version -import * as hpke from "https://deno.land/x/hpke@1.0.0/core/mod.ts"; -import * as secp256k1 from "https://deno.land/x/hpke@1.0.0/x/dhkem-secp256k1/mod.ts"; +import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts"; +import * as secp256k1 from "https://deno.land/x/hpke@1.0.1/x/dhkem-secp256k1/mod.ts"; // use the latest stable version import * as hpke from "https://deno.land/x/hpke/core/mod.ts"; @@ -104,8 +104,8 @@ This section shows some typical usage examples. @@ -49,8 +49,8 @@ Using unpkg: ```html ``` @@ -75,8 +75,8 @@ Using deno.land: ```js // use a specific version -import * as hpke from "https://deno.land/x/hpke@1.0.0/core/mod.ts"; -import * as x25519 from "https://deno.land/x/hpke@1.0.0/x/dhkem-x25519/mod.ts"; +import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts"; +import * as x25519 from "https://deno.land/x/hpke@1.0.1/x/dhkem-x25519/mod.ts"; // use the latest stable version import * as hpke from "https://deno.land/x/hpke/core/mod.ts"; @@ -104,8 +104,8 @@ This section shows some typical usage examples. @@ -49,8 +49,8 @@ Using unpkg: ```html ``` @@ -75,8 +75,8 @@ Using deno.land: ```js // use a specific version -import * as hpke from "https://deno.land/x/hpke@1.0.0/core/mod.ts"; -import * as x448 from "https://deno.land/x/hpke@1.0.0/x/dhkem-x448/mod.ts"; +import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts"; +import * as x448 from "https://deno.land/x/hpke@1.0.1/x/dhkem-x448/mod.ts"; // use the latest stable version import * as hpke from "https://deno.land/x/hpke/core/mod.ts"; @@ -104,8 +104,8 @@ This section shows some typical usage examples.