icojs - npm Package Compare versions

Comparing version 0.3.0-alpha.3 to 0.3.0

package.json

 {
   "name": "icojs",
   "description": "parse ico file",
-  "version": "0.3.0-alpha.3",
+  "version": "0.3.0",
   "author": "egy186",
@@ -20,7 +20,7 @@ "bugs": {
     "gulp-istanbul": "^0.10.0",
-    "gulp-jsdoc-to-markdown": "^1.1.1",
     "gulp-mocha": "^2.1.2",
-    "gulp-rename": "^1.2.2",
+    "gulp-mustache": "^1.0.2",
     "gulp-sourcemaps": "^1.5.2",
     "gulp-uglify": "^1.2.0",
+    "jsdoc": "^3.3.2",
     "vinyl-buffer": "^1.0.0",
@@ -27,0 +27,0 @@ "vinyl-source-stream": "^1.1.0"

README.md

@@ -27,2 +27,4 @@ # icojs
 
+__Prerequisite__: icojs relies on node-canvas, and you _must_ have installed __cairo__. Please see [node-canvas wiki](https://github.com/Automattic/node-canvas/wiki/_pages) for installation instructions.
+
 ```sh
@@ -54,45 +56,41 @@ npm install icojs
 
-<a name="ICO"></a>
-### ICO
-**Kind**: global class  
+### ICO.parse
 
-* [ICO](#ICO)
-  * [.parse(buffer)](#ICO.parse) ⇒ <code>Array.&lt;Object&gt;</code>
-  * [.isICO(buffer)](#ICO.isICO) ⇒ <code>Boolean</code>
-  * [.noConflict()](#ICO.noConflict) ⇒ <code>[ICO](#ICO)</code>
-
-<a name="ICO.parse"></a>
-#### ICO.parse(buffer) ⇒ <code>Array.&lt;Object&gt;</code>
 Parse ICO and return some PNGs.
 
-**Kind**: static method of <code>[ICO](#ICO)</code>  
-**Returns**: <code>Array.&lt;Object&gt;</code> - Array of parsed ICO.
-* .width <code>Number</code> - Image width.
-* .height <code>Number</code> - Image height.
-* .bit <code>Number</code> - Image bit depth.
-* .buffer <code>ArrayBuffer</code> - Image buffer.  
+#### Parameters
 
-| Param | Type | Description |
-| --- | --- | --- |
-| buffer | <code>ArrayBuffer</code> | The ArrayBuffer object contain the TypedArray of a ICO file. |
+* `buffer` **ArrayBuffer** - The ArrayBuffer object contain the TypedArray of a ICO file.
 
-<a name="ICO.isICO"></a>
-#### ICO.isICO(buffer) ⇒ <code>Boolean</code>
+#### Returns
+
+* **Array.&lt;Object&gt;** - Array of parsed ICO.
+  * `width` **Number** - Image width.
+  * `height` **Number** - Image height.
+  * `bit` **Number** - Image bit depth.
+  * `buffer` **ArrayBuffer** - Image buffer.
+
+### ICO.isICO
+
 Check the ArrayBuffer is valid ICO.
 
-**Kind**: static method of <code>[ICO](#ICO)</code>  
-**Returns**: <code>Boolean</code> - True if arg is ICO.  
+#### Parameters
 
-| Param | Type | Description |
-| --- | --- | --- |
-| buffer | <code>ArrayBuffer</code> | The ArrayBuffer object contain the TypedArray of a ICO file. |
+* `buffer` **ArrayBuffer** - The ArrayBuffer object contain the TypedArray of a ICO file.
 
-<a name="ICO.noConflict"></a>
-#### ICO.noConflict() ⇒ <code>[ICO](#ICO)</code>
+#### Returns
+
+* **Boolean** - True if arg is ICO.
+
+### ICO.noConflict
+
 No conflict.
 
-**Kind**: static method of <code>[ICO](#ICO)</code>  
 
+#### Returns
+
+* **ICO** - `ICO` Object.
+
 ## License
 
 MIT license

src/ico.js

@@ -149,6 +149,6 @@ /* global global: false */
    * @returns {Object[]} Array of parsed ICO.
-   * * .width <code>Number</code> - Image width.
-   * * .height <code>Number</code> - Image height.
-   * * .bit <code>Number</code> - Image bit depth.
-   * * .buffer <code>ArrayBuffer</code> - Image buffer.
+   *   * `width` **Number** - Image width.
+   *   * `height` **Number** - Image height.
+   *   * `bit` **Number** - Image bit depth.
+   *   * `buffer` **ArrayBuffer** - Image buffer.
    */
@@ -212,3 +212,3 @@ parse: function (buffer) {
    * No conflict.
-   * @returns {ICO}
+   * @returns {ICO} `ICO` Object.
    */
@@ -215,0 +215,0 @@ noConflict: function () {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

413

increased by12.84%

Worsened metrics

Total package byte prevSize

17256

decreased by-2.76%

Number of lines in readme file

95

decreased by-2.06%

No dependency changes