github-featured/zarazhangrui--beautiful-html-templates
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

docs: tighten README and add MIT license

Browse Source 
- Remove the "visually plural" plumbing detail (end users don't care)
- Remove the "Who reads what" section (TEMPLATE_SPEC.md isn't published)
- Surface AGENTS.md as the one and only doc to read
- Add MIT LICENSE
This commit is contained in:
Zara Zhang
2026-05-04 23:21:00 -07:00
parent 0b8e625b1a
commit 8f1913dbbb
2 changed files with 31 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LICENSE
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Zara Zhang
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.
README.md
+10 -19
View File
@@ -2,37 +2,24 @@
A library of reusable HTML slide templates designed so that any coding agent can pick the right one and produce a beautiful deck on the user's behalf, automatically.
The library is **visually plural**. Each template ships in its original form: its own DOM structure, its own navigation pattern, its own runtime (or no runtime). Some use a shared `<deck-stage>` web component; others use scroll-snap; others use bespoke inline keyboard handlers. **No standardization is enforced.** The agent uses each template as a design reference, not as a uniform runtime.
## Who reads what
There are two audiences for this repo, and two docs to match:
- **Agents using the library to build a user's deck → read [`AGENTS.md`](./AGENTS.md).** This is your operating manual: how to read `index.json`, match the user's brief to a template, clone it, and adapt the content.
- **The library author adding or editing templates → read [`TEMPLATE_SPEC.md`](./TEMPLATE_SPEC.md).** This is the authoring contract: folder shape, `template.json` schema, typography / palette conventions, the optional `deck-stage` runtime, etc.
End users **do not** add or modify templates. They consume the library through their agent.
Agents using the library should read [`AGENTS.md`](./AGENTS.md). It's the operating manual: how to read `index.json`, match the user's brief to a template, clone it, and adapt the content.
## Repo layout
```
beautiful-html-templates/
AGENTS.md ← operating manual for agents using the library
TEMPLATE_SPEC.md ← authoring contract for the library maintainer
README.md ← this file
index.json ← auto-generated index — the agent reads this first
index.json ← aggregate index — the agent reads this first
runtime/
deck-stage.js ← optional shared web component for templates that want it
scripts/
build-index.mjs ← regenerates index.json from all template.json files
deck-stage.js ← shared web component used by some templates
templates/
<slug>/
template.html ← the deck (5+ slides showing variety)
template.json ← metadata used for matching
styles.css ← optional, when CSS lives in a separate file
template.html ← the deck (multiple slides demonstrating the system)
template.json ← metadata: mood, tone, palette, typography, etc.
styles.css ← optional, when CSS lives separately
deck-stage.js ← bundled if the template uses the runtime
assets/ ← optional: images, fonts, svg
preview.png ← optional thumbnail
```
A template folder is **self-contained**: copying a single folder out of the repo gives a working deck.
@@ -44,3 +31,7 @@ A template folder is **self-contained**: copying a single folder out of the repo
- Total agent context cost per deck = `index.json` (~few KB) + one chosen template's HTML/CSS. Flat, regardless of library size.
Run `cat index.json` for the full machine-readable list.
## License
[MIT](./LICENSE) — free to use, modify, and distribute.