hanki-lanyard 0.1.0

package/README.md

@@ -0,0 +1,56 @@
+# hanki-lanyard
+
+Interactive 3D lanyard badge card for React apps, with Typeform-style sign-in / sign-up flows.
+
+## Install
+
+```bash
+npm install hanki-lanyard qrcode.react
+```
+
+Peer dependencies: `react`, `react-dom`, `qrcode.react`
+
+## Publish (maintainers)
+
+From this directory, with npm logged in:
+
+```bash
+npm publish
+```
+
+The package is **public** on npm. (`publishConfig.access` is set to `public`.)
+
+> **Note:** GitHub repo ownership and npm package names are separate systems.
+> The npm org `@hanki` is a different account/organization on [npmjs.com](https://www.npmjs.com).
+> This package publishes as **`hanki-lanyard`** so any npm account can publish it.
+> To use `@hanki/lanyard` later, you must own or be invited to the `@hanki` org on npm.
+
+## Quick start
+
+```tsx
+import { LanyardScene } from 'hanki-lanyard'
+
+export default function AuthPage() {
+  return (
+    <LanyardScene
+      showConfigPanel={false}
+      auth={{
+        onSubmit: async ({ mode, values, isComplete }) => {
+          if (!isComplete) return
+          console.log(mode, values)
+        },
+      }}
+    />
+  )
+}
+```
+
+## Local demo (monorepo)
+
+In `lanyardtest/package.json`:
+
+```json
+"hanki-lanyard": "file:../packages/hanki-lanyard/hanki-lanyard-0.1.0.tgz"
+```
+
+After changing source: `npm run build` in this folder, then `npm run build:pkg` in `lanyardtest/`.