Improved readme with demo and npx instructions

README.md

@@ -7,6 +7,10 @@ directly into your terminal.
 [![CircleCI](https://circleci.com/gh/lmammino/s3st.svg?style=shield)](https://circleci.com/gh/lmammino/s3st)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
+## Demo!
+
+[![asciicast](https://asciinema.org/a/dWJtrXA0HRqDJxndId9Xauz0e.svg)](https://asciinema.org/a/dWJtrXA0HRqDJxndId9Xauz0e)
+
 ## Rationale
 
 This utility is particularly useful when you are storing data in S3 and you want
@@ -24,17 +28,29 @@ realtime (gzip, brotli and deflate).
 
 ## Install
 
-With NPM (Requires Node v10+):
+There are several ways to install `s3st`:
+
+### Install global with NPM
+
+(Requires Node v10+):
 
 ```bash
 npm i -g s3st
 ```
 
+### Precompiled binaries
+
 Alternatively you can download one of the pre-compiled binaries for linux,
 windows, mac or alpine from the [Releases page](https://github.com/lmammino/s3st/releases).
 
 These binaries do not require you to have Node installed.
 
+### With [npx](https://www.npmjs.com/package/npx) (use without install)
+
+```bash
+npx s3st some-s3-bucket
+```
+
 
 ## Usage
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "s3st",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A command line utility that allows you to stream data from multiple S3 objects directly into your terminal",
   "main": "src/index.js",
   "bin": {
@@ -12,7 +12,7 @@
   "engineStrict": true,
   "scripts": {
     "test:lint": "eslint src",
-    "build": "scripts/build.sh",
+    "build": "scripts/build.sh $npm_package_version",
     "test": "npm run test:lint",
     "release:tag": "git tag $npm_package_version && git push --tags",
     "package:publish": "scripts/publish-release.js $GITHUB_TOKEN lmammino/s3st $npm_package_version"

scripts/build.sh

@@ -1,6 +1,11 @@
 #!/usr/bin/env bash
 
-node_modules/.bin/nexe . -t macos-x64-12.0.0 -o build/s3st-macos --temp .nexe
-node_modules/.bin/nexe . -t linux-x64-12.0.0 -o build/s3st-linux --temp .nexe
-node_modules/.bin/nexe . -t alpine-x64-12.0.0 -o build/s3st-alpine --temp .nexe
-node_modules/.bin/nexe . -t windows-x86-12.0.0 -o build/s3st-win.exe --temp .nexe
+VERSION=$1
+V=$(echo $VERSION | tr . _)
+
+for platform in "macos" "linux" "alpine" "win.exe"
+do
+  DEST="build/s3st-${V}-${platform}"
+  node_modules/.bin/nexe . -t macos-x64-12.0.0 -o $DEST --temp .nexe
+  gzip $DEST
+done