blessed-components 0.0.1 → 1.1.0

package/README.md

@@ -3,8 +3,8 @@
 Composable, typed terminal UI components for
 [Blessed](https://github.com/chjj/blessed).
 
-> **Project status:** foundation stage. The package structure and automated
-> release pipeline are ready; UI components are coming soon.
+> **Project status:** early development. `ProgressBar` and `Sparkline` are
+> available; more components are coming soon.
 
 ## Goals
 
@@ -17,8 +17,6 @@ Composable, typed terminal UI components for
 
 ## Installation
 
-Components are not available yet. Once the first component ships:
-
 ```sh
 npm install blessed blessed-components
 ```
@@ -31,8 +29,8 @@ npm install blessed blessed-components
 
 | Component     | Purpose                                              | Priority |
 | ------------- | ---------------------------------------------------- | -------- |
-| `ProgressBar` | Render one bounded horizontal progress bar.          | P0       |
-| `Sparkline`   | Render compact time-series data with Unicode blocks. | P0       |
+| [`ProgressBar`](./src/components/progress-bar/README.md) | Render one bounded horizontal progress bar. | Available |
+| [`Sparkline`](./src/components/sparkline/README.md) | Render compact time-series data with Unicode blocks. | Available |
 | `MetricBars`  | Render labeled metrics as aligned progress bars.     | P0       |
 | `Stat`        | Display a label and highlighted value.               | P0       |
 
@@ -110,13 +108,34 @@ Useful commands:
 
 ```sh
 npm run build
+npm run docs
+npm run docs:check
 npm test
 npm run test:watch
 npm run lint
+npm run lint:fix
+npm run biome:check
+npm run preview
 npm run typecheck
 npm run format
+npm run format:check
+```
+
+ESLint and Biome extend the shared `super-configs` presets. Biome owns
+formatting and import organization; Prettier is not used.
+
+### Terminal component preview
+
+Run the prototype component workbench:
+
+```sh
+npm run preview
 ```
 
+Use arrow keys and Enter to select stories, `r` to reload, `Tab` to move
+focus, and `q` to quit. The prototype currently previews ProgressBar and
+Sparkline stories through their public Blessed adapters.
+
 ## Testing
 
 Development follows vertical TDD slices:
@@ -129,45 +148,12 @@ Development follows vertical TDD slices:
 Tests should use public interfaces and observable output. Internal mocks and
 large snapshots are avoided.
 
-## Releases
-
-[semantic-release](https://github.com/semantic-release/semantic-release)
-publishes from `main`.
-
-Commit messages follow
-[Conventional Commits](https://www.conventionalcommits.org/):
-
-```text
-fix: clamp progress values
-feat: add progress bar renderer
-feat!: change component update contract
-```
-
-Release mapping:
-
-| Commit          | Release |
-| --------------- | ------- |
-| `fix:`          | Patch   |
-| `feat:`         | Minor   |
-| Breaking change | Major   |
-
-The release workflow:
-
-1. Validates formatting, linting, types, tests, and build.
-2. Calculates the next version from commits.
-3. Publishes the package to npm.
-4. Creates a GitHub release with generated notes.
-
-### npm trusted publishing setup
-
-Before the first release, configure an npm trusted publisher for:
-
-- Organization or user: `ElJijuna`
-- Repository: `blessed-components`
-- Workflow filename: `release.yml`
+## Releases and documentation
 
-The workflow uses GitHub Actions OIDC and npm provenance. No long-lived
-`NPM_TOKEN` is required.
+`semantic-release` publishes packages from `main`. After a real npm release
+succeeds, the same workflow generates TypeDoc for the released version and
+deploys `docs/api` to GitHub Pages. Commits that produce no release do not
+deploy documentation.
 
 ## License