Skip to content

Commit

Permalink
v4.0.7: Add dist file to npm package.
Browse files Browse the repository at this point in the history
  • Loading branch information
rochars committed Jun 11, 2018
1 parent 7fa550f commit 96ea2a0
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 10 deletions.
3 changes: 0 additions & 3 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
*.reapeaks
*.DS_Store

# minified browser version
dist/

# Development folders
.nyc_output/
docs/
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# CHANGELOG

## 4.0.7 (2018-06-11)
- Add dist file to npm package.

## 4.0.6 (2018-06-10)
- fix: chunkSize for odd number of bytes.

Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ Read and write the chunks of RIFF and RIFX files.
npm install riff-chunks
```

## Browser
Use the compiled file in the */dist* folder:
```html
<script src="riff-chunks-min.js"></script>
```

Or get it from the [jsDelivr](https://www.jsdelivr.com) CDN:
```html
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
```

## Use
```javascript
const riffChunks = require("riff-chunks");
Expand Down
2 changes: 1 addition & 1 deletion docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 11 2018 01:48:14 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 11 2018 16:21:29 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
6 changes: 4 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
<article><h1>riff-chunks</h1><p>Copyright (c) 2017-2018 Rafael da Silva Rocha.<br>https://github.com/rochars/riff-chunks</p>
<p><a href="https://www.npmjs.com/package/riff-chunks"><img src="https://img.shields.io/npm/v/riff-chunks.svg?style=for-the-badge" alt="NPM version"></a> <a href="https://rochars.github.io/riff-chunks/index.html"><img src="https://img.shields.io/badge/docs-online-blue.svg?style=for-the-badge" alt="Docs"></a><br><a href="https://codecov.io/gh/rochars/riff-chunks"><img src="https://img.shields.io/codecov/c/github/rochars/riff-chunks.svg?style=flat-square" alt="Codecov"></a> <a href="https://travis-ci.org/rochars/riff-chunks"><img src="https://img.shields.io/travis/rochars/riff-chunks.svg?style=flat-square" alt="Unix Build"></a> <a href="https://ci.appveyor.com/project/rochars/riff-chunks"><img src="https://img.shields.io/appveyor/ci/rochars/riff-chunks.svg?style=flat-square&amp;logo=appveyor" alt="Windows Build"></a> <a href="https://scrutinizer-ci.com/g/rochars/riff-chunks/"><img src="https://img.shields.io/scrutinizer/g/rochars/riff-chunks.svg?style=flat-square&amp;logo=scrutinizer" alt="Scrutinizer"></a></p>
<h2>About</h2><p>Read and write the chunks of RIFF and RIFX files.</p>
<h2>Install</h2><pre class="prettyprint source"><code>npm install riff-chunks</code></pre><h2>Use</h2><pre class="prettyprint source lang-javascript"><code>const riffChunks = require(&quot;riff-chunks&quot;);
<h2>Install</h2><pre class="prettyprint source"><code>npm install riff-chunks</code></pre><h2>Browser</h2><p>Use the compiled file in the <em>/dist</em> folder:</p>
<pre class="prettyprint source lang-html"><code>&lt;script src=&quot;riff-chunks-min.js&quot;>&lt;/script></code></pre><p>Or get it from the <a href="https://www.jsdelivr.com">jsDelivr</a> CDN:</p>
<pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/[email protected]&quot;>&lt;/script></code></pre><h2>Use</h2><pre class="prettyprint source lang-javascript"><code>const riffChunks = require(&quot;riff-chunks&quot;);
const fs = require(&quot;fs&quot;);

let chunks = riffChunks.read(fs.readFileSync(&quot;file.wav&quot;));
Expand Down Expand Up @@ -105,7 +107,7 @@ <h2>riffChunks.write()</h2><pre class="prettyprint source lang-javascript"><code
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 11 2018 01:48:14 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 11 2018 16:21:29 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ <h1 class="page-title">index.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 11 2018 01:48:14 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 11 2018 16:21:29 GMT-0300 (Hora oficial do Brasil) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "riff-chunks",
"version": "4.0.6",
"version": "4.0.7",
"description": "Read and write the chunks of RIFF and RIFX files.",
"homepage": "https://github.com/rochars/riff-chunks",
"author": "Rafael da Silva Rocha <[email protected]>",
Expand Down Expand Up @@ -44,8 +44,9 @@
"string-replace-loader": "^1.3.0",
"webpack": "^3.8.1"
},
"main": "index.js",
"dependencies": {
"byte-data": "^8.0.0"
}
},
"main": "index.js",
"browser": "./dist/riff-chunks-min.js"
}

0 comments on commit 96ea2a0

Please sign in to comment.