nudge-canvas 0.0.1 → 0.4.0

package/LICENSE.md

@@ -0,0 +1,51 @@
+# Nudge Terms of Use
+
+Last updated: 2026-11-08
+
+These terms are an agreement between you and Alteritas ("we", "us") for the Nudge software (the npm package `nudge-canvas`) and the websites nudgecanvas.com and docs.nudgecanvas.com. By installing or using Nudge, you agree to them. If you do not agree, do not install or use Nudge.
+
+## 1. License
+
+Nudge is free to use. We grant you a personal, worldwide, non-exclusive, non-transferable, revocable license to install and run Nudge on computers you own or control, for personal or commercial work.
+
+You may not:
+- sell, rent, sublicense or redistribute Nudge, or offer it as a hosted service to others;
+- copy, modify or create derivative works of Nudge, except as the law allows;
+- reverse engineer, decompile or disassemble Nudge, except to the extent the law expressly permits it despite this limit;
+- remove or change any notices of ownership or license in Nudge.
+
+Nudge is licensed, not sold. We and our licensors keep all rights not expressly granted here.
+
+Nudge includes third-party components, such as fonts, icons and UI kits, under their own licenses. They are listed in `THIRD_PARTY_NOTICES.md` in the package, and their licenses apply to those components. The open source packages npm installs with Nudge, and the Chromium browser Nudge may download, are also separate third-party components under their own licenses. Nothing in these terms limits your rights under those licenses.
+
+## 2. Your work
+
+Everything you make with Nudge (designs, files, code and other output) belongs to you. We claim no rights in it. Nudge runs on your computer and stores your work in your project folder; we do not receive a copy.
+
+## 3. Your agent and other services
+
+Nudge works with AI agents and other tools you choose and run yourself, such as Claude Code, Codex or Cursor. Your use of those tools is governed by their own terms, and what you send them is between you and their providers. Nudge may download fonts and icon sets you choose from public sources (Google Fonts, the npm registry); those are provided under their own licenses, which Nudge records in your project.
+
+## 4. Updates and changes
+
+We may update Nudge, or change or stop offering it, at any time. We may change these terms; the date above shows the latest version. Continuing to use Nudge after a change means you accept the new terms.
+
+## 5. No warranty
+
+Nudge is provided "as is" and "as available", without warranties of any kind, express or implied, including merchantability, fitness for a particular purpose and non-infringement. Keep backups of your work; we do not guarantee that Nudge will be error-free or that it will not lose data.
+
+## 6. Limitation of liability
+
+To the fullest extent the law allows, we are not liable for any indirect, incidental, special, consequential or punitive damages, or for lost profits, data or goodwill, arising from your use of Nudge or the websites. Because Nudge is free, our total liability for any claim is limited to USD 100. Nothing in these terms limits liability that cannot be limited by law, such as liability for intentional misconduct or gross negligence.
+
+## 7. Ending this agreement
+
+You may stop using Nudge at any time and remove it with `nudge-canvas init --remove` and `npm uninstall -g nudge-canvas`. Your license ends automatically if you break these terms. Sections 2, 5, 6 and 8 survive.
+
+## 8. Governing law
+
+These terms are governed by the laws of the Republic of Korea. Disputes will be resolved in the Seoul Central District Court, unless the law of your country gives you the right to bring a claim where you live.
+
+## 9. Contact
+
+hello@nudgecanvas.com

package/README.md

@@ -1,5 +1,53 @@
-# nudge-canvas
+# Nudge
 
-Nudge: design with the coding agent you already have.
+A design canvas your coding agent works on with you. Your agent designs on the canvas over MCP; you adjust
+by hand; it builds the result into your project and checks it against the design.
 
-Not released yet. This name is held for it.
+macOS or Windows. Node 22, 24 or 26+.
+
+## Install
+
+Install from your coding agent's chat or from a terminal. Both install Nudge and connect it to your agents.
+
+**From your agent's chat**: paste this into a chat with your coding agent (Claude Code, Codex, Cursor or any agent that can run commands).
+
+```
+Install Nudge and connect it: run `npm install -g nudge-canvas`, then `nudge-canvas init --yes`.
+```
+
+If your agent asks before it runs a command, allow it. If it can't, run `nudge-canvas init` yourself
+in a terminal: it asks before it changes anything.
+
+When it's done, start a new session of your agent and ask: "Open the Nudge canvas". Agents load Nudge's tools when a session starts.
+
+**From a terminal**: run these two commands.
+
+```
+npm install -g nudge-canvas
+nudge-canvas init
+```
+
+`init` finds the coding agents on this computer (Claude Code, Codex, Cursor, Gemini CLI, VS Code), shows
+what it will register and where, and asks before it writes. Each settings file it changes is kept as
+`<file>.nudge-backup` first.
+
+## Then
+
+1. Start a new session of your agent in your project's folder, so it picks up Nudge.
+2. Ask: "Open the Nudge canvas". The canvas for that folder opens in your browser, and the agent's
+   reply has its link too (http://localhost:…). Naming Nudge keeps another design tool from taking
+   the request.
+3. Design by hand, or ask your agent for a screen. Your agent draws on the canvas, you adjust by
+   hand, and it reads your changes on its next call.
+
+The design lives in your project, in `design/`, next to the code. Commit it with git like any other file.
+
+## Help
+
+Help pages: https://docs.nudgecanvas.com
+
+Updating and uninstalling: https://docs.nudgecanvas.com/update
+
+When something doesn't work: https://docs.nudgecanvas.com/troubleshooting
+
+Questions or problems: hello@nudgecanvas.com