Skip to content

Commit

Permalink
Adds NPM Package + Updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
TekWizely committed Jan 19, 2020
1 parent bbeca28 commit 5f20709
Show file tree
Hide file tree
Showing 7 changed files with 102 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@ builds:
- linux
goarch:
- amd64
- 386
archives:
- replacements:
darwin: Darwin
linux: Linux
amd64: x86_64
darwin: darwin
linux: linux
amd64: amd64
checksum:
name_template: 'checksums.txt'
snapshot:
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1030,6 +1030,17 @@ _install run from AUR using yay_
```bash
$ yay -S run-git
```
#### NPM / Yarn

NPM & Yarn users can install run via the `@tekwizely/run` package:

* [Run NPM Package Page](https://www.npmjs.com/package/@tekwizely/run)

```
$ npm i '@tekwizely/run'
$ yarn add '@tekwizely/run'
```

### Other Package Managers
I hope to have other packages available soon and will update the README as they become available.
Expand Down
2 changes: 2 additions & 0 deletions deployments/npm/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bin
node_modules
21 changes: 21 additions & 0 deletions deployments/npm/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 TekWize.ly

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 7 additions & 0 deletions deployments/npm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Run: Easily manage and invoke small scripts and wrappers

Do you find yourself using tools like `make` to manage non build-related scripts?

Build tools are great, but they are not optimized for general script management.

Run aims to be better at managing small scripts and wrappers, while incorporating a familiar make-like syntax.
16 changes: 16 additions & 0 deletions deployments/npm/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
var binwrap = require("binwrap");
var path = require("path");

var packageInfo = require(path.join(__dirname, "package.json"));
var version = packageInfo.version;
var root = "https://github.com/TekWizely/run/releases/download/v" + version
module.exports = binwrap({
dirname: __dirname,
binaries: [
"run"
],
urls: {
"darwin-x64": root + "/run_" + version + "_darwin_amd64.tar.gz",
"linux-x64": root + "/run_" + version + "_linux_amd64.tar.gz"
}
});
41 changes: 41 additions & 0 deletions deployments/npm/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "@tekwizely/run",
"version": "0.0.0",
"description": "Easily manage and invoke small scripts and wrappers",
"homepage": "https://github.com/TekWizely/run",
"license": "MIT",
"author": "TekWizely <TekWize.ly+npm@gmail.com>",
"main": "index.js",
"preferGlobal": true,
"keywords": [
"Run",
"Runfile",
"Golang"
],
"repository": {
"type": "git",
"url": "https://github.com/TekWizely/run.git"
},
"bugs": {
"url": "https://github.com/TekWizely/run/issues"
},
"scripts": {
"install": "binwrap-install",
"prepare": "binwrap-prepare",
"test": "binwrap-test",
"prepublish": "npm test"
},
"files": [
"bin",
"index.js",
"README.md",
"LICENSE"
],
"bin": {
"run": "bin/run"
},
"dependencies": {
"binwrap": "^0.2.2"
},
"devDependencies": {}
}

0 comments on commit 5f20709

Please sign in to comment.