@vouhardy/core 4.0.2-mozart.9

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Nick Thompson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# @elemaudio/core
+
+Elementary is a JavaScript/C++ library for building audio applications.
+
+The `@elemaudio/core` package provides the standard library for composing
+audio processing nodes, as well as the core graph reconciling and rendering utilities. Often this
+will be used with one of the provided renderers, `@elemaudio/web-renderer` or `@elemaudio/offline-renderer`.
+
+Please see the full documentation at [https://www.elementary.audio/](https://www.elementary.audio/)
+
+## Installation
+
+```js
+npm install --save @elemaudio/core
+```
+
+## Usage
+
+```js
+import { el, Renderer } from '@elemaudio/core';
+
+
+// Here we're using a default Renderer instance, so it's our responsibility to
+// send the instruction batches to the underlying engine
+let core = new Renderer((batch) => {
+  // Send the instruction batch somewhere: you can set up whatever message
+  // passing channel you want!
+  console.log(batch);
+});
+
+// Now we can write and render audio. How about some binaural beating
+// with two detuned sine tones in the left and right channel:
+core.render(el.cycle(440), el.cycle(441));
+```
+
+## License
+
+MIT