diff --git a/README.md b/README.md index bf9545c..bae71e4 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,20 @@ This is a [Secure Scuttlebutt](http://scuttlebutt.nz) system tray application. It provides an always-running _sbot_ for your local system. -## Dependencies +## Install on macOS through [Homebrew](https://brew.sh) + +Did not make a pull-request to the main repo yet but you can use this: + +``` +homebrew install https://raw.githubusercontent.com/ssbc/scuttle-shell/homebrew/scuttleshell.rb +``` + +## Install from source + +### Dependencies You must have [Git](https://git-scm.com) and [Node](https://nodejs.org) installed. -## Install globally ``` $ npm install -g scuttle-shell diff --git a/scuttleshell.rb b/scuttleshell.rb new file mode 100644 index 0000000..e32fa7c --- /dev/null +++ b/scuttleshell.rb @@ -0,0 +1,23 @@ +# https://docs.brew.sh/Node-for-Formula-Authors + +require "language/node" + +class Scuttleshell < Formula + desc "A system tray app for running Secure Scuttlebutt and providing sbot features to your local system" + homepage "https://github.com/ssbc/scuttle-shell" + url "https://registry.npmjs.org/scuttle-shell/-/scuttle-shell-1.0.0.tgz" + version '1.0.0' + sha256 "0aa6369f89c8c6b8510ee138ead11209da78f667cfdd98c885df7e9bcc84ae74" + + depends_on "node@10" + depends_on "python" => :build + + def install + system "npm", "install", *Language::Node.std_npm_install_args(libexec) + bin.install_symlink Dir["#{libexec}/bin/*"] + end + + test do + system "scuttleshell" + end +end