Repository navigation
Refine project README - #18
Merged
Merged
Conversation
There was a problem hiding this comment.
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
LICENSEfile in the repository and the existing package manifests (packages/taffyjs-node/package.json,packages/taffyjs-wasm/package.json) currently saylicense: 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 currentlyprivate: trueat version0.0.0, and there is no@taffyjs/yoga/@taffyjs/yoga-wasmpackage 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/nodecommand, butpackages/taffyjs-node/package.jsoncurrently hasprivate: true, version0.0.0, andlicense: 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>
| - **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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
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.mdgit diff --check