@stencila/dockter - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

package.json

 {
   "name": "@stencila/dockter",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "A Docker image builder for researchers",
@@ -17,2 +17,6 @@ "main": "dist/index.js",
     "build-bins": "pkg --out-path=build .",
+    "bundle": "npm run bundle-linux && npm run bundle-macos && npm run bundle-win",
+    "bundle-linux": "tar --transform 's|build/dockter-linux|dockter|' -czvf build/dockter-linux-x64.tar.gz build/dockter-linux",
+    "bundle-macos": "tar --transform 's|build/dockter-macos|dockter|' -czvf build/dockter-macos-x64.tar.gz build/dockter-macos",
+    "bundle-win": "mv build/dockter-win.exe build/dockter.exe ; zip -j build/dockter-win-x64.zip build/dockter.exe",
     "docs": "markdown-toc -i --maxdepth=4 README.md && typedoc --readme README.md --mode file --out ./docs ./src",
@@ -23,3 +27,3 @@ "cli": "ts-node src/cli.ts",
     "commit": "git-cz",
-    "prepublishOnly": "npm run build",
+    "prepublishOnly": "npm run build && npm run bundle",
     "semantic-release": "semantic-release"
@@ -104,12 +108,12 @@ },
             {
-              "path": "build/dockter-linux",
-              "label": "dockter-linux"
+              "path": "build/dockter-linux-x64.tar.gz",
+              "label": "dockter-linux-x64.tar.gz"
             },
             {
-              "path": "build/dockter-macos",
-              "label": "dockter-macos"
+              "path": "build/dockter-macos-x64.tar.gz",
+              "label": "dockter-macos-x64.tar.gz"
             },
             {
-              "path": "build/dockter-win.exe",
-              "label": "dockter-win.exe"
+              "path": "build/dockter-win-x64.zip",
+              "label": "dockter-win-x64.zip"
             }
@@ -116,0 +120,0 @@ ]

README.md

@@ -34,2 +34,4 @@ # Dockter : a Docker image builder for researchers
   * [CLI](#cli)
+    + [Windows](#windows)
+    + [MacOS](#macos)
   * [Package](#package)
@@ -222,10 +224,36 @@ - [Use](#use)
 
-Download the command line interface (CLI) as a pre-compiled, standalone binary for Windows, MacOS or Linux from the [releases page](https://github.com/stencila/dockter/releases).
+#### Windows
 
-For example, on Linux, you can download and install Dockter using the following command (change the version to the latest):
+To install the latest release of the `dockter` command line tool, download `dockter-win-x64.zip` for the [latest release](https://github.com/stencila/dockter/releases/) and place it somewhere on your `PATH`.
 
+#### MacOS
+
+To install the latest release of the `dockter` command line tool to `/usr/local/bin` just,
+
 ```bash
-curl -sL https://github.com/stencila/dockter/releases/download/v0.2.4/dockter-linux -o ~/.local/bin/dockter && chmod +x ~/.local/bin/dockter
+curl -L https://unpkg.com/@stencila/dockter/install-latest-macos.sh | sudo bash
 ```
 
+Or, if you'd prefer to do things manually, download `dockter-macos-x64.tar.gz` for the [latest release](https://github.com/stencila/dockter/releases/) and then,
+
+```bash
+tar xvf dockter-macos-x64.tar.gz
+sudo mv -f dockter /usr/local/bin
+```
+
+##### Linux
+
+To install the latest release of the `dockter` command line tool to `~/.local/bin/` just,
+
+```bash
+curl -L https://unpkg.com/@stencila/dockter/install-latest-linux.sh | bash
+```
+
+Or, if you'd prefer to do things manually, or place Dockter elewhere, download `dockter-linux-x64.tar.gz` for the [latest release](https://github.com/stencila/dockter/releases/) and then,
+
+```bash
+tar xvf dockter-linux-x64.tar.gz
+mv -f dockter ~/.local/bin/ # or wherever you like
+```
+
 ### Package
@@ -232,0 +260,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

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

Total package byte prevSize

229279

increased by0.83%

Number of package files

106

increased by1.92%

Number of lines in readme file

396

increased by7.61%

No dependency changes