speaker - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

History.md

@@ -0,7 +1,12 @@
+0.0.6 / 2012-12-15
+==================
+
+ - add node >= v0.9.4 compat
+
 0.0.5 / 2012-11-16
 ==================
 
-  - add initial tests (uses the "dummy" output module)
-  - add "float" (32-bit and 64-bit) output support
-  - ensure only one "close" event
+ - add initial tests (uses the "dummy" output module)
+ - add "float" (32-bit and 64-bit) output support
+ - ensure only one "close" event
 
@@ -8,0 +13,0 @@ 0.0.4 / 2012-11-04

package.json

 {
   "name": "speaker",
-  "description": "Output raw PCM audio data to the speakers",
+  "description": "Output PCM audio data to the speakers",
   "keywords": [
@@ -18,5 +18,6 @@ "pcm",
     "oss",
-    "pulse"
+    "pulse",
+    "mpg123"
   ],
-  "version": "0.0.5",
+  "version": "0.0.6",
   "author": "Nathan Rajlich <[e-mail]> (http://tootallnate.net)",
@@ -23,0 +24,0 @@ "repository": {

README.md

 node-speaker
 ============
-### Output raw PCM audio data to the speakers
+### Output [PCM audio][pcm] data to the speakers
 
 
-A Writable stream instance that accepts raw PCM audio data and outputs it to the
-speakers. The output is backed by `mpg123`'s audio output modules, which in turn
-use any number of audio backends commonly found on Operating Systems these days.
+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
+in turn use any number of audio backends commonly found on Operating Systems
+these days.
 
+
 Installation
@@ -19,3 +21,10 @@ ------------
 
+On Debian/Ubuntu, the ALSA backend is selected by default, so be sure to have the
+`alsa.h` header file in place:
 
+``` bash
+$ sudo apt-get install libasound2-dev
+```
+
+
 Example
@@ -37,3 +46,3 @@ -------
 
-// Raw PCM data from stdin gets piped into the speaker
+// PCM data from stdin gets piped into the speaker
 process.stdin.pipe(speaker);
@@ -47,7 +56,7 @@ ```
 `require('speaker')` directly returns the `Speaker` constructor. It is the only
-interface exported by node-speaker.
+interface exported by `node-speaker`.
 
 ### new Speaker([ format ]) -> Speaker instance;
 
-Creates a new `Speaker` instance, which is a writable stream that you can pipe raw
+Creates a new `Speaker` instance, which is a writable stream that you can pipe
 PCM audio data to. The optional `format` object may contain any of the `Writable`
@@ -98,1 +107,3 @@ base class options, as well as any of these PCM formatting options:
 ```
+
+[pcm]: http://en.wikipedia.org/wiki/Pulse-code_modulation

No alert changes

Improved metrics

Total package byte prevSize

3402770

increased by0.01%

Number of lines in readme file

106

increased by11.58%

No dependency changes