uqr 0.0.0 → 0.0.2

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Project Nayuki
+Copyright (c) 2023 Anthony Fu <https://github.com/antfu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# uqr
+
+[![NPM version](https://img.shields.io/npm/v/uqr?color=a1b858&label=)](https://www.npmjs.com/package/uqr)
+
+Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.
+
+## Install
+
+```bash
+# Using npm
+npm install uqr
+
+# Using yarn
+yarn add uqr
+
+# Using pnpm
+pnpm add uqr
+```
+
+## Usage
+
+```ts
+import {
+  encode,
+  renderANSI,
+  renderSVG,
+  renderUnicode,
+  renderUnicodeCompact,
+} from 'uqr'
+
+const svg = renderSVG('Hello, World!')
+
+const ansi = renderANSI('https://192.168.1.100:3000', {
+  // Error correction level
+  ecc: 'L',
+  // Border width
+  border: 2,
+})
+
+// display QR Code in terminal
+console.log(ansi)
+```
+
+## API
+
+### `encode`
+
+Encode plain text or binary data into QR Code represented by a 2D array.
+
+```ts
+import { encode } from 'uqr'
+
+const {
+  data, // 2D array of boolean, representing the QR Code
+  version, // QR Code version
+  size, // size of the QR Code
+} = encode(text, options)
+```
+
+### `renderANSI`
+
+Render QR Code to [ANSI colored](https://ss64.com/nt/syntax-ansi.html) string.
+
+```ts
+import { renderANSI } from 'uqr'
+
+const string = renderANSI(text, options)
+
+console.log(string)
+```
+
+### `renderUnicode`
+
+Render QR Code to Unicode string for each pixel. By default it uses `█` and `░` to represent black and white pixels, and it can be customizable.
+
+```ts
+import { renderUnicode } from 'uqr'
+
+const string = renderUnicode(text, {
+  blackChar: '█',
+  whiteChar: '░',
+  // ...other options
+})
+```
+
+### `renderUnicodeCompact`
+
+Render QR Code with two rows into one line with unicode `▀`, `▄`, `█`, ` `. It is useful when you want to display QR Code in terminal with limited height.
+
+```ts
+import { renderUnicodeCompact } from 'uqr'
+
+const string = renderUnicodeCompact(text, options)
+
+console.log(string)
+```
+
+### `renderSVG`
+
+Render QR Code to SVG string.
+
+```ts
+import { renderSVG } from 'uqr'
+
+const string = renderSVG(text, options)
+```
+
+## Credits
+
+QR Code generation algorithm is modified from [nayuki/QR-Code-generator](https://github.com/nayuki/QR-Code-generator/blob/master/typescript-javascript/qrcodegen.ts) by Project Nayuki.
+
+CLI renders are inspired by [qrcode-terminal](https://github.com/gtanner/qrcode-terminal).
+
+## License
+
+[MIT](./LICENSE) License