@hpke/hybridkem-x-wing 0.1.0 → 0.2.0

package/README.md

@@ -22,40 +22,32 @@ Documentation: [jsr.io](https://jsr.io/@hpke/hybridkem-x-wing/doc) |
   - [Node.js](#nodejs)
   - [Deno](#deno)
   - [Web Browsers](#web-browsers)
-  - [Cloudflare Workers](#cloudflare-workers)
 - [Usage](#usage)
 - [Contributing](#contributing)
 
 ## Installation
 
+`@hpke/hybridkem-x-wing` need to be used with
+[@hpke/core](https://github.com/dajiaji/hpke-js/blob/main/packages/core/README.md),
+which can be installed in the same manner as desribed below.
+
 ### Node.js
 
-Using npm:
+You can install the package with npm, yarn or pnpm.
 
 ```sh
+# Using npm:
 npm install @hpke/hybridkem-x-wing
-```
-
-Using yarn:
-
-```sh
 yarn add @hpke/hybridkem-x-wing
+pnpm install @hpke/hybridkem-x-wing
+# Using jsr:
+npx jsr add @hpke/hybridkem-x-wing
+yarn dlx jsr add @hpke/hybridkem-x-wing
+pnpm dlx jsr add @@hpke/hybridkem-x-wing
 ```
 
-### Deno
-
-Starting from version 1.3.0, hpke-js packages are available from the JSR
-registry. From this version onwards, please use JSR import instead of HTTPS
-import in Deno.
-
-**JSR imoprt (recommended on `>=1.3.0`):**
-
-Add hpke-js packages using the commands below:
-
-```sh
-deno add @hpke/core
-deno add @hpke/hybridkem-x-wing
-```
+The above manner can be used with other JavaScript runtimes that support npm,
+such as Cloudflare Workers and Bun.
 
 Then, you can use the module from code like this:
 
@@ -64,15 +56,12 @@ import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
 import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
 ```
 
-**HTTPS imoprt (deprecated):**
+### Deno
 
-```ts
-import {
-  Aes128Gcm,
-  CipherSuite,
-  HkdfSha256,
-} from "https://deno.land/x/hpke/core/mod.ts";
-import { HybridkemXWing } from "https://deno.land/x/hpke/x/hybridkem-x-wing/mod.ts";
+For Deno, it is recommended to use the jsr.io registry.
+
+```sh
+deno add jsr:@hpke/hybridkem-x-wing
 ```
 
 ### Web Browsers
@@ -85,15 +74,23 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@<SEMVER>";
-  import * as kyber from "https://esm.sh/@hpke/hybridkem-x-wing@<SEMVER>";
+  import {
+    Aes128Gcm,
+    CipherSuite,
+    HkdfSha256,
+  } from "https://esm.sh/@hpke/core@<SEMVER>";
+  import { HybridkemXWing } from "https://esm.sh/@hpke/hybridkem-x-wing@<SEMVER>";
   // ...
 </script>
 
 <!-- use the latest stable version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core";
-  import * as kyber from "https://esm.sh/@hpke/hybridkem-x-wing";
+  import {
+    Aes128Gcm,
+    CipherSuite,
+    HkdfSha256,
+  } from "https://esm.sh/@hpke/core";
+  import { HybridkemXWing } from "https://esm.sh/@hpke/hybridkem-x-wing";
   // ...
 </script>
 ```
@@ -103,22 +100,16 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
-  import * as kyber from "https://unpkg.com/@hpke/hybridkem-x-wing@<SEMVER>/esm/mod.js";
+  import {
+    Aes128Gcm,
+    CipherSuite,
+    HkdfSha256,
+  } from "https://unpkg.com/@hpke/core@<SEMVER>/esm/mod.js";
+  import { HybridkemXWing } from "https://unpkg.com/@hpke/hybridkem-x-wing@<SEMVER>/esm/mod.js";
   // ...
 </script>
 ```
 
-### Cloudflare Workers
-
-```sh
-git clone git@github.com:dajiaji/hpke-js.git
-cd hpke-js/x/hybridkem-x-wing
-npm install -g esbuild
-deno task dnt
-deno task minify > $YOUR_SRC_PATH/hpke-hybridkem-x-wing.js
-```
-
 ## Usage
 
 This section shows some typical usage examples.
@@ -128,7 +119,6 @@ This section shows some typical usage examples.
 ```js
 import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
 import { HybridkemXWing } from "@hpke/hybridkem-x-wing";
-// const { HybridkemXWing } = require("@hpke/hybridkem-x-wing");
 
 async function doHpke() {
   // setup
@@ -208,7 +198,7 @@ try {
 }
 ```
 
-### Browsers
+### Web Browsers
 
 ```html
 <html>
@@ -219,8 +209,8 @@ try {
         Aes128Gcm,
         CipherSuite,
         HkdfSha256,
-      } from "https://esm.sh/@hpke/core@<SEMVER>";
-      import { HybridkemXWing } from "https://esm.sh/@hpke/hybridkem-x-wing@<SEMVER>";
+      } from "https://esm.sh/@hpke/core";
+      import { HybridkemXWing } from "https://esm.sh/@hpke/hybridkem-x-wing";
 
       globalThis.doHpke = async () => {
         try {

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@hpke/hybridkem-x-wing",
-  "version": "0.1.0",
-  "description": "A Hybrid Public Key Encryption (HPKE) module extension for a hybrid post-quantum KEM, X25519Kyber768Draft00",
+  "version": "0.2.0",
+  "description": "A Hybrid Public Key Encryption (HPKE) module extension for X-Wing: general-purpose hybrid post-quantum KEM.",
   "keywords": [
     "hpke",
-    "rfc9180",
-    "kem",
+    "ml-kem",
     "kyber",
     "x25519",
     "post-quantum",
+    "pqc",
+    "x-wing",
     "security",
     "encryption"
   ],
@@ -42,7 +43,7 @@
   "dependencies": {
     "@hpke/common": "^1.4.3",
     "@hpke/dhkem-x25519": "^1.4.3",
-    "@noble/hashes": "^1.4.0",
+    "@noble/hashes": "^1.5.0",
     "mlkem": "^2.2.0"
   },
   "devDependencies": {