dockerode-compose - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "dockerode-compose",
-  "version": "1.0.0",
-  "description": "",
-  "main": "main.js",
+  "version": "1.0.1",
+  "description": "docker-compose in nodejs using dockerode",
+  "main": "./lib/compose.js",
   "scripts": {
@@ -13,8 +13,16 @@ "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "Pedro Dias <[e-mail]>",
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/apocas/dockerode-compose/issues"
   },
-  "homepage": "https://github.com/apocas/dockerode-compose#readme"
+  "keywords": [
+    "docker",
+    "docker-compose"
+  ],
+  "homepage": "https://github.com/apocas/dockerode-compose#readme",
+  "dependencies": {
+    "dockerode": "^3.2.1",
+    "js-yaml": "^4.0.0"
+  }
 }

README.md

@@ -1,1 +0,46 @@
-# dockerode-compose
+# dockerode-compose
+
+docker-compose in Node.js using [dockerode](https://github.com/apocas/dockerode).
+
+Work in progress...
+
+## Installation
+
+`npm install dockerode-compose`
+
+
+### Getting started
+
+To use `dockerode` first you need to instantiate it:
+
+``` js
+var Dockerode = require('dockerode');
+var DockerodeCompose = require('dockerode-compose');
+
+var docker = new Dockerode();
+var compose = new DockerodeCompose(docker);
+
+(async () => {
+  var state = await compose.compose('./test/wordpress.yml', 'wordpress');
+  console.log(state);
+})();
+```
+
+## Tests
+
+ * `docker pull ubuntu:latest` to prepare your system for the tests.
+ * Tests are implemented using `mocha` and `chai`. Run them with `npm test`.
+
+## Examples
+
+Check the examples folder for more specific use cases examples.
+
+## License
+
+Pedro Dias - [@pedromdias](https://twitter.com/pedromdias)
+
+Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:
+
+    http://www.apache.org/licenses/LICENSE-2.0.html
+
+Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the 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

Filesystem access

Supply chain risk

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

Found 1 instance in 1 package

Fixed alerts

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20482

increased by72.93%

Number of package files

7

increased by133.33%

Number of low license alerts

0

decreased by-100%

Lines of code

214

increased byInfinity%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

47

increased by4600%

Worsened metrics

Dependency count

2

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addeddockerode@^3.2.1

• + Addedjs-yaml@^4.0.0

• + Added@balena/dockerignore@1.0.2(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedbl@4.1.0(transitive)

• + Addedbuffer@5.7.1(transitive)

• + Addedbuildcheck@0.0.6(transitive)

• + Addedchownr@1.1.4(transitive)

• + Addedcpu-features@0.0.10(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addeddocker-modem@3.0.8(transitive)

• + Addeddockerode@3.3.5(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedfs-constants@1.0.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedjs-yaml@4.1.0(transitive)

• + Addedmkdirp-classic@0.5.3(transitive)

• + Addedms@2.1.3(transitive)

• + Addednan@2.22.0(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedpump@3.0.2(transitive)

• + Addedreadable-stream@3.6.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsplit-ca@1.0.1(transitive)

• + Addedssh2@1.16.0(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedtar-fs@2.0.1(transitive)

• + Addedtar-stream@2.2.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwrappy@1.0.2(transitive)