Skip to content

Commit

Permalink
npm publish
Browse files Browse the repository at this point in the history
  • Loading branch information
aolsenjazz committed Jan 13, 2021
1 parent 04e4f9b commit f9b2f04
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ coverage/
node_modules
src/wasm-src.js
**/.DS_Store
package-lock.json
package-lock.json
.npmignore
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ libsamplerate-js is a port of [libsamplerate](http://www.mega-nerd.com/SRC/) to

Install using NPM:
```bash
npm i libsamplerate-js
npm i @alexanderolsen/libsamplerate-js
```
Then place the WASM code located at */node_modules/libsamplerate-js/wasm-src.wasm* into the root of your public directory. **libsamplerate-js will fail if it is unable to find this file in the root of your public directory.** Examples of this can be found in the *examples* or *benchmarks* directories.

Expand Down Expand Up @@ -55,7 +55,7 @@ LibSampleRate.create(converterType, nChannels, inputSampleRate, ouputSampleRate)

### In HTML:
```html
<script src="https://cdn.jsdelivr.net/npm/libsamplerate-js"></script>
<script src="https://cdn.jsdelivr.net/npm/@alexanderolsen/libsamplerate-js"></script>
<script>
var converterType = LibSampleRate.ConverterType.SRC_SINC_BEST_QUALITY;
var nChannels = 2;
Expand Down Expand Up @@ -137,7 +137,7 @@ and visit *localhost:8080/benchmarks*. A minimalistic UI is provided to test dif

## Building From Source

To build and compile the JS + WASM resources from source, run:
Before you can compile the WASM code you need to [download and install Empscripten](https://emscripten.org/docs/getting_started/downloads.html) and activate PATH variables for the current terminal. To build and compile the JS + WASM resources from source, run:

```bash
git clone https://github.com/aolsenjazz/libsamplerate-js
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "libsamplerate-js",
"version": "1.0.0",
"name": "@alexanderolsen/libsamplerate-js",
"version": "1.0.1",
"description": "Resample audio in-browser using a web assembly port of libsamplerate.",
"keywords": [
"web assembly",
Expand Down

0 comments on commit f9b2f04

Please sign in to comment.