update readme, package.json (#9)

Author: marcello3d

README.md

@@ -1,21 +1,27 @@
 # @descript/web-audio-js
 
 ![Node CI](https://github.com/descriptinc/web-audio-js/workflows/Node%20CI/badge.svg)
-[![NPM Version](https://img.shields.io/npm/v/@descript/web-audio-js.svg?style=flat-square)](https://www.npmjs.org/package/@descript/web-audio-js)
-[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://mohayonao.mit-license.org/)
+[![NPM Version](https://img.shields.io/npm/v/@descript/web-audio-js.svg)](https://www.npmjs.org/package/@descript/web-audio-js)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://mohayonao.mit-license.org/)
 
 > Pure JS implementation of the [Web Audio API](https://www.w3.org/TR/webaudio/)
 
+Fork of [mohayonao/web-audio-engine](https://github.com/mohayonao/web-audio-engine) with following changes:
+
+- Use TypeScript and fix some types
+  - Remove `BaseAudioContext.suspend()`
+- Add new `RawDataAudioContext`
+- Bug fixes
+  - Fixes for `BiquadFilterNode` and `DelayNode`
+  - Fix WAVE decoding
+  - Fix `AudioNode.disconnect(x)` not disconnecting
+
 ## Installation
 
 ```
 npm install --save web-audio-engine
 ```
 
-##### download
-
-- [web-audio-engine.js](https://raw.githubusercontent.com/mohayonao/web-audio-engine/master/build/web-audio-engine.js)
-
 ## API
 
 `web-audio-engine` provides some `AudioContext` class for each use-case: audio playback, rendering and simulation.
@@ -105,6 +111,38 @@ context.encodeAudioData(audioData).then((arrayBuffer) => {
 });
 ```
 
+### Class: RawDataAudioContext
+
+`RawDataAudioContext` allows you to synchronously step through an AudioContext. This is useful for streaming output at
+and controlling the rate 
+
+##### new RawDataAudioContext(opts?: object)
+
+Creates new `RenderingAudioContext` instance.
+
+- `opts.sampleRate: number` audio sample rate (in Hz) - _default: 44100_
+- `opts.numberOfChannels: number` audio channels (e.g. 2: stereo) - _default: 2_
+- `opts.blockSize: number` samples each rendering quantum - _default: 128_
+
+##### context.process(channelData: Float32Array[], offset: number = 0)
+
+Renders the next `blockSize` samples of audio into `channelData`.
+
+```js
+import { RawDataAudioContext } from 'web-audio-engine';
+const context = new RawDataAudioContext();
+const { blockSize } = context;
+const channelData = [
+  new Float32Array(blockSize),
+  new Float32Array(blockSize),
+];
+
+for (let i = 0; i < 100_000; i += blockSize)
+  context.process(channelData);
+  // Do something with channeLData
+}
+```
+
 ### Class: WebAudioContext
 
 :construction*worker: \_TODO: WRITE DESCRIPTION*

package.json

@@ -7,7 +7,7 @@
     "Marcello Bastea-Forte <marcello@descript.com>"
   ],
   "bugs": {
-    "url": "https://github.com/mohayonao/web-audio-engine/issues"
+    "url": "https://github.com/descriptinc/web-audio-js/issues"
   },
   "dependencies": {
     "audio-type": "^1.0.2",
@@ -44,7 +44,7 @@
     "src",
     "build"
   ],
-  "homepage": "https://github.com/descriptinc/web-audio-engine/",
+  "homepage": "https://github.com/descriptinc/web-audio-js/",
   "keywords": [
     "web audio api"
   ],
@@ -54,7 +54,7 @@
   "types": "build/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/descriptinc/web-audio-engine.git"
+    "url": "https://github.com/descriptinc/web-audio-js.git"
   },
   "scripts": {
     "build": "rollup -c",