Skip to content

Commit 74c3c70

Browse files
committed
Improved readme with demo and npx instructions
1 parent 84878cd commit 74c3c70

File tree

4 files changed

+29
-8
lines changed

4 files changed

+29
-8
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ directly into your terminal.
77
[![CircleCI](https://circleci.com/gh/lmammino/s3st.svg?style=shield)](https://circleci.com/gh/lmammino/s3st)
88
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
99

10+
## Demo!
11+
12+
[![asciicast](https://asciinema.org/a/dWJtrXA0HRqDJxndId9Xauz0e.svg)](https://asciinema.org/a/dWJtrXA0HRqDJxndId9Xauz0e)
13+
1014
## Rationale
1115

1216
This utility is particularly useful when you are storing data in S3 and you want
@@ -24,17 +28,29 @@ realtime (gzip, brotli and deflate).
2428

2529
## Install
2630

27-
With NPM (Requires Node v10+):
31+
There are several ways to install `s3st`:
32+
33+
### Install global with NPM
34+
35+
(Requires Node v10+):
2836

2937
```bash
3038
npm i -g s3st
3139
```
3240

41+
### Precompiled binaries
42+
3343
Alternatively you can download one of the pre-compiled binaries for linux,
3444
windows, mac or alpine from the [Releases page](https://github.com/lmammino/s3st/releases).
3545

3646
These binaries do not require you to have Node installed.
3747

48+
### With [npx](https://www.npmjs.com/package/npx) (use without install)
49+
50+
```bash
51+
npx s3st some-s3-bucket
52+
```
53+
3854

3955
## Usage
4056

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "s3st",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "A command line utility that allows you to stream data from multiple S3 objects directly into your terminal",
55
"main": "src/index.js",
66
"bin": {
@@ -12,7 +12,7 @@
1212
"engineStrict": true,
1313
"scripts": {
1414
"test:lint": "eslint src",
15-
"build": "scripts/build.sh",
15+
"build": "scripts/build.sh $npm_package_version",
1616
"test": "npm run test:lint",
1717
"release:tag": "git tag $npm_package_version && git push --tags",
1818
"package:publish": "scripts/publish-release.js $GITHUB_TOKEN lmammino/s3st $npm_package_version"

scripts/build.sh

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#!/usr/bin/env bash
22

3-
node_modules/.bin/nexe . -t macos-x64-12.0.0 -o build/s3st-macos --temp .nexe
4-
node_modules/.bin/nexe . -t linux-x64-12.0.0 -o build/s3st-linux --temp .nexe
5-
node_modules/.bin/nexe . -t alpine-x64-12.0.0 -o build/s3st-alpine --temp .nexe
6-
node_modules/.bin/nexe . -t windows-x86-12.0.0 -o build/s3st-win.exe --temp .nexe
3+
VERSION=$1
4+
V=$(echo $VERSION | tr . _)
5+
6+
for platform in "macos" "linux" "alpine" "win.exe"
7+
do
8+
DEST="build/s3st-${V}-${platform}"
9+
node_modules/.bin/nexe . -t macos-x64-12.0.0 -o $DEST --temp .nexe
10+
gzip $DEST
11+
done

0 commit comments

Comments
 (0)