@flux-lang/brand 0.1.13 → 0.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @flux-lang/brand
|
|
2
|
+
|
|
3
|
+
1) **What this package is**
|
|
4
|
+
Shared Flux brand identity helpers and renderers for CLI and web surfaces.
|
|
5
|
+
|
|
6
|
+
2) **When you use it**
|
|
7
|
+
Use it when you need consistent Flux version branding, taglines, or UI assets in CLI or web tooling.
|
|
8
|
+
|
|
9
|
+
3) **Install**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @flux-lang/brand
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
4) **Basic usage**
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { coerceVersionInfo, formatFluxVersion, FLUX_TAGLINE } from "@flux-lang/brand";
|
|
19
|
+
|
|
20
|
+
const info = coerceVersionInfo({ version: "v0.1.4", channel: "canary" });
|
|
21
|
+
console.log(formatFluxVersion(info.version));
|
|
22
|
+
console.log(FLUX_TAGLINE);
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
5) **Reference**
|
|
26
|
+
- **Entry points**:
|
|
27
|
+
- `@flux-lang/brand` (shared helpers) → `src/index.ts`
|
|
28
|
+
- `@flux-lang/brand/cli` (CLI-specific helpers) → `src/cli.ts`
|
|
29
|
+
- `@flux-lang/brand/web` (web/React helpers) → `src/web.tsx`
|
|
30
|
+
|
|
31
|
+
6) **How it relates to IR/runtime**
|
|
32
|
+
This package does not touch IR or runtime behavior. It provides shared branding and version presentation only.
|
|
33
|
+
|
|
34
|
+
7) **Gotchas & troubleshooting**
|
|
35
|
+
- The web entry point has React peer dependencies. Install `react`/`react-dom` if you use `@flux-lang/brand/web`.
|
|
36
|
+
|
|
37
|
+
8) **Versioning / compatibility notes**
|
|
38
|
+
TBD / Not yet implemented.
|
|
39
|
+
|
|
40
|
+
9) **Links**
|
|
41
|
+
- Root Flux manual: [`../../README.md`](../../README.md)
|
|
42
|
+
- Source: [`src/`](src/)
|