summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiguel Mota <miguelmota2@gmail.com>2018-04-26 16:19:19 -0700
committerMiguel Mota <miguelmota2@gmail.com>2018-04-26 16:19:19 -0700
commit7d7340366e6f792d88e0671e47877c8aac9364ba (patch)
treecb25e82a40d9ea581f5ab39bee30eeedd11c46e7
parentd94e6e2c1c772a9fc5a99d5f3470a632e27dbda5 (diff)
brew instructions1.0.0
-rw-r--r--Makefile6
-rw-r--r--README.md35
2 files changed, 36 insertions, 5 deletions
diff --git a/Makefile b/Makefile
index a537b05..4f4f066 100644
--- a/Makefile
+++ b/Makefile
@@ -34,3 +34,9 @@ snap/deploy:
snap/remove:
snap remove cointop
+
+brew/remove:
+ brew uninstall cointop
+
+brew/build: brew/remove
+ brew install --build-from-source cointop.rb
diff --git a/README.md b/README.md
index ee965a1..19deab2 100644
--- a/README.md
+++ b/README.md
@@ -50,11 +50,16 @@ Make sure to have [go](https://golang.org/) (1.9+) installed, then do:
go get -u github.com/miguelmota/cointop
```
-### Windows WSL
+### Homebrew (macOS)
-You'll need additional font support for Windows WSL. Please see the [wiki](https://github.com/miguelmota/cointop/wiki/Windows-Command-Prompt-and-WSL-Font-Support) for instructions.
+cointop is available via [Homebrew](https://brew.sh/) for macOS:
-### Snap
+```bash
+brew tap cointop/cointop https://github.com/miguelmota/cointop
+brew install cointop
+```
+
+### Snap (Linux)
cointop is also available as a [snap](https://snapcraft.io/cointop) for Linux users.
@@ -70,6 +75,10 @@ sudo snap run cointop
Note: snaps don't work in Windows WSL. See this [issue thread](https://forum.snapcraft.io/t/windows-subsystem-for-linux/216).
+### Windows WSL (Windows)
+
+You'll need additional font support for Windows WSL. Please see the [wiki](https://github.com/miguelmota/cointop/wiki/Windows-Command-Prompt-and-WSL-Font-Support) for instructions.
+
## Updating
To update make sure to use the `-u` flag.
@@ -78,7 +87,7 @@ To update make sure to use the `-u` flag.
go get -u github.com/miguelmota/cointop
```
-### snap
+### Snap
Use the `refresh` command to update snap.
@@ -86,6 +95,12 @@ Use the `refresh` command to update snap.
sudo snap refresh cointop --stable
```
+### Homebrew
+
+```bash
+brew uninstall cointop && brew install cointop
+```
+
<!--
#### Alternatively (without go)
@@ -346,12 +361,22 @@ Action|Description
## Development
-Build snap
+### Snap
+
+Building snap
```bash
$ make snap/build
```
+### Homebrew
+
+Installing from source
+
+```bash
+make brew/build
+```
+
## License
Released under the [Apache 2.0](./LICENSE.md) license.