Skip to content

Refine project README - #18

Merged
hyfdev merged 5 commits into
mainfrom
agent/refine-readme
Aug 16, 2026
Merged

hyfdev merged 5 commits into
mainfrom
agent/refine-readme

Conversation

@hyfdev

@hyfdev hyfdev commented Aug 16, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace internal bootstrap notes with a concise project overview and focused feature list
  • explain the native and WebAssembly runtime choices alongside the Yoga compatibility packages
  • add the default installation command, package links and version placeholders, project credits, and MIT license section

Impact

The root README now presents TaffyJS as a consumable project and makes its package and runtime choices clear. This change does not affect runtime behavior.

Validation

  • vp fmt --check README.md
  • git diff --check

@hyfdev
hyfdev marked this pull request as ready for review August 16, 2026 08:51
Copilot AI lite review requested due to automatic review settings August 16, 2026 08:51
@hyfdev
hyfdev merged commit 62a45e1 into main Aug 16, 2026
6 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR rewrites the root README.md from internal bootstrap/development notes into a consumer-facing overview of TaffyJS, emphasizing runtime options (native vs WebAssembly) and planned Yoga compatibility.

Changes:

  • Replaced the opening description with a feature-oriented overview and runtime positioning.
  • Added an installation snippet plus a packages table with links/placeholders.
  • Added credits and a short license section.
Suppressed comments (3)

README.md:37

  • The README declares the project is MIT licensed, but there is no top-level LICENSE file in the repository and the existing package manifests (packages/taffyjs-node/package.json, packages/taffyjs-wasm/package.json) currently say license: UNLICENSED. Align the repository license file and package metadata with the intended license to avoid conflicting licensing information.
MIT

README.md:27

  • This table links to npm and uses version placeholders, but the only in-repo packages (@taffyjs/node, @taffyjs/wasm) are currently private: true at version 0.0.0, and there is no @taffyjs/yoga / @taffyjs/yoga-wasm package in this repository. Consider removing the npm links and explicitly marking the current packages as unreleased/planned to avoid broken links and inaccurate expectations.
| [`@taffyjs/node`](https://www.npmjs.com/package/@taffyjs/node)           | Native Node.js runtime for maximum performance. | —       |
| [`@taffyjs/wasm`](https://www.npmjs.com/package/@taffyjs/wasm)           | WebAssembly runtime for flexible deployment.    | —       |
| [`@taffyjs/yoga`](https://www.npmjs.com/package/@taffyjs/yoga)           | Yoga-compatible API backed by `@taffyjs/node`.  | —       |
| [`@taffyjs/yoga-wasm`](https://www.npmjs.com/package/@taffyjs/yoga-wasm) | Yoga-compatible API backed by `@taffyjs/wasm`.  | WIP     |

README.md:18

  • The README gives an npm install @taffyjs/node command, but packages/taffyjs-node/package.json currently has private: true, version 0.0.0, and license: UNLICENSED, which strongly suggests it's not published/consumable from npm yet. Add a note clarifying the packages are not published yet (or update the docs to match the actual release state).
## Installation

```sh
npm install @taffyjs/node
</details>



---

💡 <a href="/hyfdev/taffyjs/new/main?filename=.github/skills/code-review/SKILL.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add a `code-review` agent skill</a> or configure MCP servers for context-aware, tailored reviews. <a href="https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review#mcp-servers-and-agent-skills" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn more in the docs.</a>

Comment thread README.md
- **Native performance:** Runs Taffy as native Rust code in Node.js through Node-API.
- **WebAssembly support:** Runs Taffy in bundled browsers and deployments where a native addon is not the right fit.
- **One API, two runtimes:** The same JavaScript API, backed by native code in `@taffyjs/node` for performance or WebAssembly in `@taffyjs/wasm` for flexibility.
- **Yoga compatibility:** Use `@taffyjs/yoga` or `@taffyjs/yoga-wasm` (work in progress) while preserving Yoga's API shape for straightforward migration.
hyfdev added a commit that referenced this pull request Aug 16, 2026
Add the public website, package documentation, guides, and usage examples.

Refs: #5, #18, #21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants