@heycys/gallery 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Heycys
+
+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

@@ -1,3 +1,51 @@
-# Temporary Holding Version
+# Gallery
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Gallery — Where humans and AI agents create together.** An agent-first, HTML-native workspace where AI agents
+write HTML, humans edit in a Notion-like interface, and both stay in sync.
+
+An AI agent (Claude Code, Codex…) writes a document from your materials as HTML; you watch it appear and edit it
+in your browser as it is written, your edits and the agent's merged; it is delivered as one offline HTML file.
+This package is the `gallery` command, its local server and the browser workbench; the agent learns it from the
+Gallery skill, which the command installs.
+
+## Requirements
+
+Node.js 22.13 or newer (https://nodejs.org, the LTS) on macOS, Linux or Windows. Editing in the browser and
+`gallery qa` need Chrome or Microsoft Edge.
+
+## Install
+
+```sh
+npm i -g @heycys/gallery
+gallery skill install      # the skill, for Claude Code and/or Codex (--agent, --project, --dir <folder>)
+```
+
+An agent given only the skill runs `gallery --version` first and asks you before it installs the command. On
+macOS or Linux, if `npm i -g` says EACCES, give npm a folder of your own (`npm config set prefix ~/.npm-global`,
+then add `~/.npm-global/bin` to PATH) rather than using sudo.
+
+## Quick start
+
+```sh
+gallery new my-doc "My document"   # makes it, starts the server, prints the address
+gallery open                       # the workbench in your browser
+gallery export my-doc              # <workspace>/exports/my-doc.html, one offline file
+gallery help                       # every command
+```
+
+With an agent: install the skill, then ask it to use Gallery (`$gallery` in Codex). It creates the document,
+gives you the address to watch and edit it, writes, checks it with `gallery qa` and hands you the exported file.
+
+Documents live in a workspace: `Gallery` in your Documents folder (`~/Documents/Gallery`; on Windows the one
+Explorer shows, OneDrive's when OneDrive backs it up) unless you name another (`--workspace <dir>`, the
+`GALLERY_WORKSPACE` variable, or `gallery init <dir>`, which marks a folder as one). Each document is a folder
+(`<slug>/doc.html`, `doc.json`), the deliverables are in `exports/`, and Gallery keeps its own state in `.gallery/`.
+
+The server listens on 127.0.0.1 only (a port from 4317), one per workspace; `gallery stop` stops it. After
+upgrading, run `gallery open` once (the server of the version before stops by itself and the new one starts) and
+`gallery skill install` again (the skill of the new version). From the older Gallery skill (the whole tools in the
+agent's skills folder), `gallery skill install` copies its documents into the workspace and moves it out of the
+skills folder, never deleting it.
+
+MIT License. The third-party code and data the package carries are listed with their licenses in
+THIRD-PARTY-NOTICES.md.