planet-client - npm Package Compare versions

Comparing version 0.0.0 to 0.1.0

package.json

 {
   "name": "planet-client",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "A client for Planet's imagery API",
@@ -12,8 +12,26 @@ "repository": {
   },
-  "licenses": [
-    {
-      "type": "Apache-2.0",
-      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-    }
-  ]
+  "license": "Apache-2.0",
+  "main": "lib/api/index.js",
+  "scripts": {
+    "pretest": "eslint bin examples lib test",
+    "test": "mocha --recursive test",
+    "start": "watchy --watch bin,examples,lib,test -- npm test"
+  },
+  "bin": {
+    "planet": "bin/planet.js"
+  },
+  "devDependencies": {
+    "chai": "^3.0.0",
+    "eslint": "^0.22.1",
+    "eslint-config-planet": "^2.0.0",
+    "mocha": "^2.2.5",
+    "sinon": "^1.15.3",
+    "watchy": "^0.6.2"
+  },
+  "dependencies": {
+    "batch": "^0.5.2",
+    "bistre": "^1.0.1",
+    "bole": "^2.0.0",
+    "yargs": "^3.13.0"
+  }
 }

readme.md

@@ -1,5 +0,35 @@
-## planet-client-js
+## planet-client
 
 A JavaScript client for [Planet's imagery API](https://www.planet.com/docs/).
 
+### Installation
+
+The `planet-client` package can be installed with `npm` (which comes with [Node](https://nodejs.org/)).  To add the package as a dependency to your project, run the following:
+
+    npm install planet-client --save
+
+### Use
+
+The `planet-client` package can be used in a Node based project or in the browser with a CommonJS module loader (like [Browserify](http://browserify.org/) or [Webpack](http://webpack.github.io/)).
+
+The library requires a global [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) implementation.  This comes with Node >= 0.12 and [modern browsers](http://caniuse.com/#search=promise).  To use `planet-client` in an environment without `Promise`, you can [use a polyfill](https://www.google.com/search?q=promise+polyfill).
+
+### Contributing
+
+To get set up, clone the repository and install the development dependencies:
+
+    git clone [e-mail]:planetlabs/planet-client-js.git
+    cd planet-client-js
+    npm install
+
+Run the tests to ensure any changes meet the coding style and maintain the expected functionality:
+
+    npm test
+
+During development, you can start a file watcher that runs the linter and tests with any file changes:
+
+    npm start
+
+[![Current Status](https://travis-ci.org/planetlabs/planet-client-js.svg?branch=master)](https://travis-ci.org/planetlabs/planet-client-js)
+
 ### License
@@ -6,0 +36,0 @@

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

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

Network access

Supply chain risk

This module accesses the network.

Found 3 instances in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

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

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

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

57103

increased by5182.42%

Number of package files

39

increased by1850%

Lines of code

1792

increased byInfinity%

Number of lines in readme file

42

increased by250%

Worsened metrics

Dependency count

4

increased byInfinity%

Dev dependency count

6

increased byInfinity%

Number of low supply chain risk alerts

10

increased byInfinity%

Number of medium supply chain risk alerts

15

increased by1400%

Dependency changes

• + Addedbatch@^0.5.2

• + Addedbistre@^1.0.1

• + Addedbole@^2.0.0

• + Addedyargs@^3.13.0

• + Addedansi-regex@0.2.12.1.1(transitive)

• + Addedansi-styles@1.1.0(transitive)

• + Addedbatch@0.5.3(transitive)

• + Addedbistre@1.0.1(transitive)

• + Addedbole@2.0.0(transitive)

• + Addedcamelcase@2.1.1(transitive)

• + Addedchalk@0.5.1(transitive)

• + Addedcliui@3.2.0(transitive)

• + Addedcode-point-at@1.1.0(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addedduplexer@0.1.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedhas-ansi@0.1.0(transitive)

• + Addedindividual@3.0.0(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedinvert-kv@1.0.0(transitive)

• + Addedis-fullwidth-code-point@1.0.0(transitive)

• + Addedisarray@0.0.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedlcid@1.0.0(transitive)

• + Addednumber-is-nan@1.0.1(transitive)

• + Addedos-locale@1.4.0(transitive)

• + Addedreadable-stream@1.0.34(transitive)

• + Addedsplit@0.3.3(transitive)

• + Addedstream-combiner@0.2.2(transitive)

• + Addedstring-width@1.0.2(transitive)

• + Addedstring_decoder@0.10.31(transitive)

• + Addedstrip-ansi@0.3.03.0.1(transitive)

• + Addedsupports-color@0.2.0(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedthrough2@0.5.1(transitive)

• + Addedwindow-size@0.1.4(transitive)

• + Addedwrap-ansi@2.1.0(transitive)

• + Addedxtend@3.0.0(transitive)

• + Addedy18n@3.2.2(transitive)

• + Addedyargs@3.32.0(transitive)