📦 @realscanner/library — Development & Publishing Guide

This document explains how to build, test locally, rename, and publish your custom scanner library based on ZXing.

1️⃣ Project Structure (Cleaned Version)

/realscanner-library
├── src/                 # All TypeScript source files
├── dist/                # Auto-generated compiled JS (after build)
├── package.json
├── tsconfig.json
├── README.md
└── LICENSE

Removed folders You removed the following, which is correct:

• test/
• .github/
• .vscode/
• example/

These are not required for publishing the library.

2️⃣ package.json (Updated for @realscanner/library)

{
  "name": "@realscanner/library",
  "version": "1.0.0",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "module": "dist/index.js",
  "scripts": {
    "build": "tsc -p tsconfig.json",
    "clean": "rm -rf dist"
  },
  "files": [
    "dist"
  ],
  "license": "MIT"
}

3️⃣ tsconfig.json (Updated Paths)

{
  "compilerOptions": {
    "baseUrl": "./",
    "module": "commonjs",
    "target": "es5",
    "moduleResolution": "node",
    "lib": ["es7", "dom"],
    "sourceMap": true,
    "declaration": true,
    "preserveConstEnums": true,
    "downlevelIteration": true,
    "paths": {
      "@realscanner/library": ["./dist"],
      "@realscanner/library/*": ["./dist/*"]
    }
  },
  "include": ["src/**/*.ts"]
}

4️⃣ Install Dependencies

npm install

5️⃣ Build the Library

npm run build

After this, dist/ will be created automatically.

6️⃣ Test Locally With npm link

Step 1 — Link the library

npm link

Step 2 — Link it in another project

Inside your React/Node project:

npm link @realscanner/library

Step 3 — Import it

import { BrowserMultiFormatReader } from "@realscanner/library";

7️⃣ Publish to npm

Make sure you're logged in:

npm login

Increase version:

npm version patch

Publish:

npm publish --access public

8️⃣ Install in Any Project

npm install @realscanner/library

9️⃣ README Template (Copy This)

# @realscanner/library

A fast, lightweight, TypeScript-first barcode + QR scanning library inspired by ZXing.  
Optimized for browser performance, ES5-compatible builds, and zero-dependency scanning.

## 🚀 Install

```sh
npm install @realscanner/library

📖 Usage Example

import { BrowserMultiFormatReader } from "@realscanner/library";

const reader = new BrowserMultiFormatReader();

reader.decodeFromVideoDevice(null, "video", (result, err) => {
  if (result) {
    console.log(result.getText());
  }
});

🛠 Development

npm install
npm run build

📤 Publish

npm publish --access public

📄 License

MIT © 2025 RealScanner