av - npm Package Compare versions

Comparing version 0.3.1 to 0.4.0

package.json

 {
   "name": "av",
   "description": "Audio decoding framework",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "author": {
-      "name": "Audiocogs",
-      "url": "http://audiocogs.org/"
+    "name": "Audiocogs",
+    "url": "http://audiocogs.org/"
   },
   "repository": {
-      "type": "git",
-      "url": "https://github.com/audiocogs/aurora.js.git"
+    "type": "git",
+    "url": "https://github.com/audiocogs/aurora.js.git"
   },
@@ -18,12 +18,27 @@ "bugs": "https://github.com/audiocogs/aurora.js/issues",
   "devDependencies": {
-      "coffee-script": ">=1.0",
-      "qunit-cli": "*",
-      "importer": ">=0.4"
+    "coffee-script": ">=1.0",
+    "qunit-cli": "*",
+    "browserify": "^4.1.10",
+    "coffeeify": "^0.6.0",
+    "exorcist": "^0.1.6"
   },
   "scripts": {
-      "prepublish": "node_modules/.bin/importer node.coffee node.js",
-      "test": "node_modules/.bin/importer node.coffee node.js; node_modules/.bin/importer tests/test.coffee"
+    "prepublish": "make js",
+    "postpublish": "make clean",
+    "test": "coffee tests/test.coffee"
   },
-  "engine": [ "node >= v0.6.0" ],
-  "main": "node.js"
+  "engine": [
+    "node >= v0.6.0"
+  ],
+  "main": "./node",
+  "browserify": {
+    "transform": [
+      "coffeeify"
+    ]
+  },
+  "browser": {
+    "./node": "./browser.coffee",
+    "./src/sources/node/file.coffee": "./src/sources/browser/file.coffee",
+    "./src/sources/node/http.coffee": "./src/sources/browser/http.coffee"
+  }
 }

README.md

@@ -23,20 +23,56 @@ Aurora.js
 
-## Building
+## Usage
 
-Currently, the [importer](https://github.com/devongovett/importer) module is used to build Aurora.js.  You can run
-the development server by first installing `importer` with npm, and then running it like this:
+You can use Aurora.js both in the browser, as well as in Node.js.  In the browser,
+you can either download a prebuilt [release](https://github.com/audiocogs/aurora.js/releases)
+or use [browserify](https://github.com/substack/node-browserify) to build it into your own 
+app bundle (see below for Node.js usage - it's the same for browserify).
 
-    npm install importer -g
-    importer browser.coffee -p 8080
+```html
+<script src="aurora.js"></script>
+<script src="mp3.js"></script>
+<!-- more codecs here -->
+```
+
+To use Aurora.js in Node.js or a browserify build, you can install it from `npm`:
+
+    npm install av
     
-You can also build a static version like this:
+Then, require the module and codecs you need:
 
-    importer browser.coffee aurora.js
+```javascript
+var AV = require('av');
+require('mp3');
+// more codecs here...
+```
+
+For much more detailed information on how to use Aurora.js, check out the 
+[documentation](https://github.com/audiocogs/aurora.js/wiki).
+
+## Building
+
+We use [browserify](https://github.com/substack/node-browserify) to build Aurora.js.  To build Aurora.js 
+for the browser yourself, use the following commands:
+
+    npm install
+    make browser
     
-By itself, Aurora will play LPCM, uLaw and aLaw files in a number of containers.  Be sure to add additional codec support 
-by including some of our other decoders such as [FLAC.js](https://github.com/audiocogs/flac.js), 
-[ALAC.js](https://github.com/audiocogs/alac.js), and [MP3.js](https://github.com/devongovett/mp3.js).
+This will place a built `aurora.js` file, as well as a source map in the `build/` directory.
 
+By itself, Aurora will play LPCM, uLaw and aLaw files in a number of containers.
+Be sure to add additional codec support by including some of our other decoders:
+
+* [FLAC.js](https://github.com/audiocogs/flac.js) 
+* [ALAC.js](https://github.com/audiocogs/alac.js)
+* [MP3.js](https://github.com/audiocogs/mp3.js)
+* [AAC.js](https://github.com/audiocogs/aac.js)
+
+If you want to build Aurora without the default codecs, you can use the "browser_slim" profile:
+
+    make browser_slim
+
+This can help shave off approx. 30 KB from the joined file, or 20 KB when minified.
+
 ## License
 
 Aurora.js is released under the MIT license.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Debug access

Supply chain risk

Uses debug, reflection and dynamic code execution features.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Number of package files

8

increased by100%

Number of lines in readme file

77

increased by87.8%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

5191

decreased by-94.77%

Dev dependency count

5

increased by66.67%

Lines of code

10

decreased by-99.65%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes