@lynx-js/qrcode-rsbuild-plugin-canary 0.3.2 → 0.3.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lynx-js/qrcode-rsbuild-plugin
 
+## 0.3.3
+
+### Patch Changes
+
+- f6c56fb: Add `README.md`.
+
 ## 0.3.2
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,93 @@
+<p align="center">
+  <a href="https://lynxjs.org/rspeedy" target="blank"><img src="https://lynxjs.org/assets/rspeedy-banner.png" alt="Rspeedy Logo" /></a>
+</p>
+
+<p>
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@lynx-js/qrcode-rsbuild-plugin">
+    <img alt="" src="https://img.shields.io/npm/v/@lynx-js/qrcode-rsbuild-plugin?logo=npm">
+  </a>
+  <a aria-label="License" href="https://www.npmjs.com/package/@lynx-js/qrcode-rsbuild-plugin">
+    <img src="https://img.shields.io/badge/License-Apache--2.0-blue" alt="license" />
+  </a>
+</p>
+
+A Rsbuild plugin that generates and displays QR codes for Lynx bundles directly in the terminal.
+
+## Getting Started
+
+```bash
+npm install -D @lynx-js/qrcode-rsbuild-plugin
+```
+
+## Usage
+
+<!-- eslint-disable -->
+
+```js
+import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin'
+
+export default {
+  plugins: [pluginQRCode()],
+}
+```
+
+## Options
+
+### `schema`
+
+Type: `(url: string) => string | Record<string, string>`\
+Default: `(url) => ({ http: url })`
+
+The `schema` option allows you to customize the URL format displayed in the QR code.
+
+<!-- eslint-disable -->
+
+```js
+import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin'
+import { defineConfig } from '@lynx-js/rspeedy'
+
+export default defineConfig({
+  plugins: [
+    pluginQRCode({
+      schema(url) {
+        return `lynx://${url}?dev=1`
+      },
+    }),
+  ],
+})
+```
+
+You can also define multiple schemas to switch between them by pressing `a` in the terminal:
+
+<!-- eslint-disable -->
+
+```js
+import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin'
+import { defineConfig } from '@lynx-js/rspeedy'
+
+export default defineConfig({
+  plugins: [
+    pluginQRCode({
+      schema(url) {
+        return {
+          http: url,
+          foo: `foo://lynx?url=${encodeURIComponent(url)}&dev=1`,
+          bar: `bar://lynx?url=${encodeURIComponent(url)}`,
+        }
+      },
+    }),
+  ],
+})
+```
+
+## Documentation
+
+Visit [Lynx Website](https://lynxjs.org/api/rspeedy/qrcode-rsbuild-plugin.pluginqrcode.html) to view the full documentation.
+
+## Contributing
+
+Contributions to Rspeedy are welcome and highly appreciated. However, before you jump right into it, we would like you to review our [Contribution Guidelines](/contributing.md) to make sure you have a smooth experience contributing to this project.
+
+## License
+
+Rspeedy is Apache-2.0 licensed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/qrcode-rsbuild-plugin-canary",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "A rsbuild plugin for printing QRCode in terminal",
   "keywords": [
     "rsbuild",
@@ -47,7 +47,7 @@
     "@microsoft/api-extractor": "7.51.0",
     "@rsbuild/core": "1.2.11",
     "@types/qrcode-terminal": "^0.12.2",
-    "@lynx-js/rspeedy": "npm:@lynx-js/rspeedy-canary@0.8.2-canary-20250302-1abf8f01"
+    "@lynx-js/rspeedy": "npm:@lynx-js/rspeedy-canary@0.8.2"
   },
   "engines": {
     "node": ">=18"