@sparkletree/cli 0.1.0 → 0.1.1

package/README.md

@@ -1,12 +1,18 @@
 # @sparkletree/cli
 
-`sparkletree add` — copy SparkleTree component source into your repo, in the
-shadcn/ui style. No install needed:
+Copy SparkleTree component source into your project, in the same distribution
+style as [shadcn/ui](https://ui.shadcn.com/). No install needed:
 
 ```bash
 npx @sparkletree/cli add hero cta
 ```
 
+Each component is written into your repo as plain React + Tailwind source that
+you own and can edit freely. The copies talk to SparkleTree through
+[`@sparkletree/react`](https://www.npmjs.com/package/@sparkletree/react) and
+[`@sparkletree/core`](https://www.npmjs.com/package/@sparkletree/core), which
+they import like any other dependency.
+
 ## Commands
 
 ```
@@ -15,54 +21,50 @@ sparkletree list
 sparkletree help
 ```
 
-| Option | |
+| Option | What it does |
 |---|---|
 | `--dir <path>` | Where components are written. Default `components`. |
 | `--cwd <path>` | Project root. Default: current directory. |
 | `--force` | Overwrite files that already exist. |
 | `--dry-run` | Show what would happen; write nothing. |
 
-Dependencies are resolved for you — asking for `hero` also writes `provider` if
-you do not have it.
+Dependencies between components are resolved for you — asking for `hero` also
+writes `provider` if you don't have it yet.
 
 ## Components
 
-| | |
+| Name | What you get |
 |---|---|
-| `provider` | The `SparkletreeProvider` wrapper, reading your env vars. |
-| `hero` | Streaming hero: headline, body, art. |
-| `cta` | Streaming call-to-action. |
-| `copy-card` | The copy-card creative. |
-| `product-card` | Product creative with price and CTA. |
+| `provider` | `SparkletreeProvider` wired to your environment variables. |
+| `hero` | A hero section with streaming headline, body, and artwork. |
+| `cta` | A call-to-action with a streaming label. |
+| `copy-card` | A text card. |
+| `product-card` | A product card with price and call-to-action. |
 
-The copies require Tailwind CSS for their default classes. Swap them freely —
-they are yours.
+The default classes use Tailwind CSS. Restyle or restructure however you like —
+the files are yours.
 
-## What "yours" means, and the one thing it does not include
+## Your copies survive protocol changes
 
-Copied components are your code: we cannot patch them, deprecate them, or know
-what they look like a year from now. So they are **wire-ignorant by
-construction** — no event names, no protocol versions, no transports, no
-endpoints, no timing constants. A CI test enforces this per component.
+The copied files contain only markup and presentation — no endpoints, event
+formats, or timing constants. Everything that talks to SparkleTree's servers
+lives in `@sparkletree/react` and `@sparkletree/core`. When the protocol
+evolves, you update those packages through npm like any other dependency, and
+your copied components keep working unchanged.
 
-Everything that speaks the wire stays in
-[`@sparkletree/react`](https://www.npmjs.com/package/@sparkletree/react) and
-[`@sparkletree/core`](https://www.npmjs.com/package/@sparkletree/core), which
-the copies import from. That is what buys the property that makes copy-paste
-distribution safe: **a protocol change is a version bump, never a migration
-guide.**
-
-It also means the adaptation mark is not in the copied source. It renders
-inside `StreamText`, in npm, and deleting it from your copy is not possible
-because it was never there. That is deliberate — see rule 4 in the
-[SDK README](https://gitlab.com/sparkletree/sparkletree-sdk/-/blob/main/README.md).
+One consequence worth knowing: the small mark that labels AI-adapted text is
+rendered by the npm package (`StreamText`), not by your copied source. Readers
+can always tell adapted text from authored text, regardless of how the copies
+are edited.
 
-## Choose one distribution, not both
+## Pick one distribution style
 
 Either import components from `@sparkletree/react`, or copy them with this CLI
-and import from `./components/sparkletree/…`. Doing both gives you two Heroes
-with the same name and a confusing diff.
+and import from `./components/sparkletree/…`. Mixing both leaves you with two
+components of the same name.
 
 ## Requirements
 
 Node >= 18. ESM only.
+
+Full documentation: [docs.sparkletree.io](https://docs.sparkletree.io/developers/sdk/cli/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sparkletree/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "sparkletree — add SparkleTree components to your project.",
   "license": "MIT",
   "type": "module",