jscad-raspberrypi - npm Package Compare versions

Comparing version 1.1.2 to 1.2.0

package.json

 {
   "name": "jscad-raspberrypi",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "jscad parts library for RaspberryPi",
   "main": "jscad-raspberrypi.jscad",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 0"
   },
@@ -35,4 +35,4 @@ "keywords": [
   "dependencies": {
-    "jscad-utils": "^2.0.0"
+    "jscad-utils": "^3.0.2"
   }
 }

README.md

@@ -7,8 +7,6 @@ [![view on npm](http://img.shields.io/npm/v/jscad-raspberrypi.svg)](https://www.npmjs.org/package/jscad-raspberrypi) [![npm module downloads](http://img.shields.io/npm/dt/jscad-raspberrypi.svg)](https://www.npmjs.org/package/jscad-raspberrypi)
 
-This is a collection of jscad parts that model a RaspberryPi BPlus and various Hats. These models use the [jscad-utils](https://github.com/johnwebbcole/jscad-utils) library and return jscad-utils [`group` objects](https://github.com/johnwebbcole/jscad-utils#utilgroupnames-objects--object).
+This is a collection of jscad parts that model a RaspberryPi BPlus and various Hats.  These models use the [jscad-utils](https://github.com/johnwebbcole/jscad-utils) library and return jscad-utils [`group` objects](https://github.com/johnwebbcole/jscad-utils#utilgroupnames-objects--object).
 
-[Here](http://openjscad.org/#https://gist.githubusercontent.com/johnwebbcole/d05fe472a86cfc31b4f1342cbf8acb12/raw/1bccaf05956958775fac248096ae8bc4666e286e/rpi-test.jscad) is a live example.
 
 ## Installation
-
 Install `jscad-raspberrypi` using NPM:
@@ -21,3 +19,2 @@
 ## Basic usage
-
 To use the utilities, you need to include the `jscad-raspberrypi.jscad` file and a copy of `lodash`.
@@ -28,2 +25,3 @@
 include('node_modules/jscad-raspberrypi/jscad-raspberrypi.jscad');
+include('node_modules/lodash/lodash.js');
 
@@ -40,15 +38,11 @@ main() {
 ## Yeoman Generator
+You can use the [yeoman jscad generator](https://www.npmjs.com/package/generator-jscad) which will create a project that uses this library.
 
-You can use the [yeoman jscad generator](https://www.npmjs.com/package/generator-jscad) which will create a project that can use this library.
+Once you create your project, install `jscad-raspberrypi`, and run `gulp`.  Dragging the `dist` directory into [http://openjscad.org/](http://openjscad.org/) will include this library.
 
-Once you create your project, install `jscad-raspberrypi`, and run `gulp`. Dragging the file in the `dist` directory into <http://openjscad.org/> will include this library.
-
-```bash
-npm install --save jscad-raspberrypi
-```
-
 Modify your `main.jscad` file to return a RaspberryPi object.
 
 ```javascript
-
+// include:js
+// endinject
 /* exported main, getParameterDefinitions */
@@ -64,5 +58,2 @@ /* globals piexample */
 }
-
-// include:js
-// endinject
 ```
@@ -74,38 +65,37 @@
 
-- [RaspberryPi](#module_RaspberryPi)
+* [RaspberryPi](#module_RaspberryPi)
+    * [.BPlus()](#module_RaspberryPi.BPlus)
+    * [.Hat()](#module_RaspberryPi.Hat)
+    * [.PiTFT24()](#module_RaspberryPi.PiTFT24)
+    * [.CameraModule()](#module_RaspberryPi.CameraModule)
 
-  - [.BPlus()](#module_RaspberryPi.BPlus)
-  - [.Hat()](#module_RaspberryPi.Hat)
-  - [.PiTFT24()](#module_RaspberryPi.PiTFT24)
-  - [.CameraModule()](#module_RaspberryPi.CameraModule)
+<a name="module_RaspberryPi.BPlus"></a>
 
-[]()
-
 ### RaspberryPi.BPlus()
+Returns a complete RaspberryPi B Plus model.
+![bplus example](jsdoc2md/bplus.png)
 
-Returns a complete RaspberryPi B Plus model. ![bplus example](jsdoc2md/bplus.png)
+**Kind**: static method of <code>[RaspberryPi](#module_RaspberryPi)</code>  
+<a name="module_RaspberryPi.Hat"></a>
 
-**Kind**: static method of `[RaspberryPi](#module_RaspberryPi)`<br>
-[]()
-
 ### RaspberryPi.Hat()
+Returns an empty Pi Hat.
+![hat example](jsdoc2md/hat.gif)
 
-Returns an empty Pi Hat. ![hat example](jsdoc2md/hat.gif)
+**Kind**: static method of <code>[RaspberryPi](#module_RaspberryPi)</code>  
+<a name="module_RaspberryPi.PiTFT24"></a>
 
-**Kind**: static method of `[RaspberryPi](#module_RaspberryPi)`<br>
-[]()
-
 ### RaspberryPi.PiTFT24()
+Returns an Adafruit PiTFT 2.4 Hat with buttons.
+![PiTFT 2.4 example](jsdoc2md/pitft24.png)
 
-Returns an Adafruit PiTFT 2.4 Hat with buttons. ![PiTFT 2.4 example](jsdoc2md/pitft24.png)
+**Kind**: static method of <code>[RaspberryPi](#module_RaspberryPi)</code>  
+<a name="module_RaspberryPi.CameraModule"></a>
 
-**Kind**: static method of `[RaspberryPi](#module_RaspberryPi)`<br>
-[]()
-
 ### RaspberryPi.CameraModule()
+Returns an Pi camera module.
+![camera example](jsdoc2md/camera.png)
 
-Returns an Pi camera module. ![camera example](jsdoc2md/camera.png)
+**Kind**: static method of <code>[RaspberryPi](#module_RaspberryPi)</code>  
 
-**Kind**: static method of `[RaspberryPi](#module_RaspberryPi)`
-
-© 2016 John Cole [[e-mail]](mailto:[e-mail]). Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).
+&copy; 2016 John Cole <[e-mail]>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).

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

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

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

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4600435

increased by0.02%

Worsened metrics

Number of lines in readme file

96

decreased by-9.43%

Dependency changes

• + Added@jscad/csg@0.3.70.3.8(transitive)

• + Added@jscad/scad-api@0.4.2(transitive)

• + Addedjscad-utils@3.2.0(transitive)

• - Removedjscad-utils@2.0.0(transitive)

• Updatedjscad-utils@^3.0.2