@jtarrio/webrtlsdr 0.0.2 → 0.0.3

package/README.md

@@ -32,6 +32,8 @@ I want to write a comprehensive set of documentation, but in the meantime, here
 
 ### High-level access to RTL-SDR (demodulate and play through the computer's speakers)
 
+This program is a complete stereo FM radio receiver tuned for 88.5 MHz.
+
 ```typescript
 import { Demodulator } from "@jtarrio/webrtlsdr/demod/demodulator";
 import { getMode } from "@jtarrio/webrtlsdr/demod/scheme";
@@ -40,18 +42,26 @@ import { RTL2832U_Provider } from "@jtarrio/webrtlsdr/rtlsdr/rtl2832u";
 
 const sampleRate = 1024000;
 let demodulator = new Demodulator(sampleRate);
-let radio = new Radio(new RTL2832U_Provider(), spectrum, sampleRate);
+let radio = new Radio(new RTL2832U_Provider(), demodulator, sampleRate);
 
 radio.setFrequency(88500000);
 demodulator.setVolume(1);
 demodulator.setMode(getMode("WBFM"));
 
-getElementById("playButton").addEventListener("click", () => radio.start());
-getElementById("stopButton").addEventListener("click", () => radio.stop());
+document
+  .getElementById("playButton")
+  .addEventListener("click", () => radio.start());
+document
+  .getElementById("stopButton")
+  .addEventListener("click", () => radio.stop());
 ```
 
+You can also see a full example at [`examples/highlevel`](examples/highlevel/script.js).
+
 ### Low-level access (read samples straight from the stick)
 
+This program connects to the RTL-SDR stick, tunes to 88.5 MHz, reads 65536 samples, and closes the connection.
+
 ```typescript
 let provider = new RTL2832U_Provider();
 let device = await provider.get();
@@ -60,10 +70,13 @@ await device.setCenterFrequency(88500000);
 await device.setGain(null);
 await device.resetBuffer();
 let samples = await device.readSamples(65536);
+await device.close();
 ```
 
+You can also see a full example at [`examples/lowlevel`](examples/lowlevel/script.js).
+
 ## Acknowledgements
 
-This is a spinoff of https://github.com/jtarrio/radioreceiver, which is, in turn, a fork of https://github.com/google/radioreceiver. I am the original author, but I was employed by Google at the time.
+This is a spinoff of https://github.com/jtarrio/radioreceiver, which is, in turn, a fork of https://github.com/google/radioreceiver. (I am the original author, but I was employed by Google at the time.)
 
 Kudos and thanks to the [RTL-SDR project](http://sdr.osmocom.org/trac/wiki/rtl-sdr) for figuring out the magic numbers needed to drive the USB tuner.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jtarrio/webrtlsdr",
   "description": "Access RTL-SDR devices and receive and demodulate radio signals from your web application",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "author": "Jacobo Tarrio <jtarrio@gmail.com>",
   "license": "Apache-2.0",
   "repository": {