Skip to content

Update readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heavyrubberslave merged 2 commits into from
Jan 11, 2026
Merged

Update readme #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1d24c0
Update readme
heavyrubberslave Jan 11, 2026
bced005
Fix typo
heavyrubberslave Jan 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# node-speaker

> **Info:** This is a fork of the original node-speaker package. It includes the fixes for Linux ARM64 support and
> the muting of the coreaudio buffer underflow warning.
> CI has been extended to all major OS/Arch/Node combinations and dependencies haven been updated.
> Node >=18 is required now.

## Output [PCM audio][pcm] data to the speakers

[![Build Status](https://github.com/TooTallNate/node-speaker/workflows/Node%20CI/badge.svg)](https://github.com/TooTallNate/node-speaker/actions?workflow=Node+CI)
[![Build Status](https://github.com/SlvCtrlPlus/node-speaker/workflows/Node%20CI/badge.svg)](https://github.com/SlvCtrlPlus/node-speaker/actions?workflow=Node+CI)

A Writable stream instance that accepts [PCM audio][pcm] data and outputs it
to the speakers. The output is backed by `mpg123`'s audio output modules, which
Expand Down