docs: Phase 2 — Audio module documentation#4
Merged
vaibhav1312 merged 1 commit intomainfrom Mar 27, 2026
Merged
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.