audiobits 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # audiobits
 
+## 0.1.2
+
+### Patch Changes
+
+- 7f792f9: Clarify npm installation and the minimal confirmation-sound quick start in the shipped README and Skill, with nearby browser gesture and lifecycle guidance.
+
+## 0.1.1
+
+### Patch Changes
+
+- Correct stale unpublished-package wording and document registry installation with `npm install audiobits`. Runtime behavior is unchanged.
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -1,20 +1,21 @@
 # AudioBits
 
-AudioBits **0.1.0** is prepared for stable publication but has not yet been published to npm. It includes confirmation, impact, thruster, tactile click, gentle rejection,
+AudioBits is available on npm as `audiobits`. It includes confirmation, impact, thruster, tactile click, gentle rejection,
 glass notification, whoosh and power-up; schema-1 recipes; play/live controls; seeded variation; bounded
 voices; bus gain, mute and routing; native output taps; and explicit lifecycle APIs.
 Prerelease verification target: current Chromium. Other browsers and operating
 systems are unverified and deliberately deferred. Maintainer listening acceptance for the
-unchanged sound definitions is recorded separately. Nothing has been published,
-and the npm identifier remains `audiobits`.
+unchanged sound definitions is recorded separately.
 
-## Try locally
+## Quick start
 
-Install the reviewed archive into your own private consumer with
-`npm install /path/to/audiobits-0.1.0.tgz`. This is a local file install,
-not an instruction to install an existing registry package. Use a browser
-bundler and call `play()` directly from a gesture handler. Surface rejection
-with `void play().catch(showError)` and retry from a fresh gesture.
+```sh
+npm install audiobits
+```
+
+Use a browser bundler. Create the engine and sound once; run the final two lines
+inside a user gesture handler, such as a button click. Call `audio.start()`
+directly in that handler and await it before playback.
 
 ```ts
 import { createAudio } from "audiobits";
@@ -22,19 +23,15 @@ import { confirmation } from "audiobits/recipes";
 
 const audio = createAudio();
 const sound = audio.sound(confirmation);
-export async function play() {
-  await audio.start();
-  sound.play();
-}
-export function stop() {
-  audio.stopAll({ tails: "cut" });
-}
-export async function dispose() {
-  await audio.dispose();
-}
+
+await audio.start();
+sound.play();
 ```
 
-Bind `play()` to a button click (`void play().catch(showError)`).
+Surface activation failures and retry from a fresh gesture. Use
+`audio.stopAll({ tails: "cut" })` to stop playback and `await audio.dispose()`
+when the host is removed. See the production lifecycle example below for
+hiding and navigation.
 
 ## Production lifecycle
 

package/dist/capabilities.json

@@ -1,5 +1,5 @@
 {
-  "packageVersion": "0.1.0",
+  "packageVersion": "0.1.2",
   "schemaVersion": 1,
   "status": "stable",
   "recipe": {

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "audiobits",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Procedural browser audio: versioned recipes, live controls, managed voices and buses.",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joacod/audiobits.git",
+    "directory": "packages/audiobits"
+  },
   "type": "module",
   "sideEffects": false,
   "files": [

package/skill/SKILL.md

@@ -5,13 +5,15 @@ description: Integrate AudioBits procedural sounds into a browser application, i
 
 # AudioBits integration
 
-This guide ships with AudioBits 0.1.0, prepared for stable publication but not yet published to npm. Confirm the installed
+This guide ships with the `audiobits` npm package. Confirm the installed
 package version and read `audiobits/capabilities.json` and
 `audiobits/schema.json` before choosing primitives. Package metadata describes
 shipped behavior, not registry availability. Prerelease verification target: current Chromium. Other browsers and operating
 systems are unverified and deliberately deferred.
 
-Use public imports from `audiobits` and `audiobits/recipes`. Create engines and
+Install with `npm install audiobits` and use a browser bundler. Follow the
+[package quick start](../README.md#quick-start) to play the bundled `confirmation`
+recipe with public imports from `audiobits` and `audiobits/recipes`. Create engines and
 sounds without browser activation, then invoke `start()` synchronously inside
 a user gesture and await it before `play()`. Surface failures and allow a fresh
 gesture retry. Never queue playback across Stop, hiding, or disposal.