Skip to content

docs: Phase 2 — Audio module documentation#4

Merged
vaibhav1312 merged 1 commit intomainfrom
docs/phase2-audio
Mar 27, 2026
Merged

docs: Phase 2 — Audio module documentation#4
vaibhav1312 merged 1 commit intomainfrom
docs/phase2-audio

Conversation

@vaibhav1312
Copy link
Copy Markdown
Collaborator

Updates all documentation to reflect the Phase 2 audio module (PR #3).

README.md — hero text, comparison table (+4 rows), features list, new Audio Playback section, tree shaking updated, roadmap Phase 2 checked.

API.md (+370 lines) — full audio API reference: MorsePlayer, sound presets, WAV export, scheduler, audio types.

CHANGELOG.md — v0.2.0 entry.

CONTRIBUTING.md — bundle targets updated, audio contribution guide added.

- README: add audio to hero text, comparison table, features list; add Audio
  Playback section with MorsePlayer, presets, WAV export, callbacks examples;
  update tree shaking to show /audio sub-path; mark Phase 2 complete in roadmap
- API.md: add full audio API reference — MorsePlayer class, constructor options,
  play/pause/stop/resume/dispose, sound presets table, WAV export functions
  (toWav, toWavBlob, toWavUrl, downloadWav), scheduler (buildSchedule,
  scheduleDuration), all audio types
- CHANGELOG: add v0.2.0 entry with audio features
- CONTRIBUTING: update bundle size targets (audio ≤ 6KB, full ≤ 12KB); add
  Adding Audio Features contribution guide
@vaibhav1312 vaibhav1312 merged commit 583e4c8 into main Mar 27, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant