added install section to readme

jerson · Sep 28, 2019 · f1fb1e1 · f1fb1e1
1 parent de8b3e1
commit f1fb1e1
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -47,6 +47,17 @@ changelog:
     exclude:
       - "^docs:"
       - "^test:"
+archives:
+  - replacements:
+      darwin: Darwin
+      linux: Linux
+      windows: Windows
+      386: i386
+      amd64: x86_64
+    format_overrides:
+      - goos: windows
+        format: zip
+
 brews:
   - name: pgrok
     github:
@@ -57,4 +68,6 @@ brews:
       email: [email protected]
     folder: Formula
     homepage: "https://github.com/jerson/pgrok"
-    description: "Introspected tunnels to localhost a fork from pgrok."
+    description: "Introspected tunnels to localhost a fork from pgrok."
+    test: |
+      system "#{bin}/pgrok -v"
diff --git a/README.md b/README.md
@@ -2,6 +2,15 @@
 # pgrok - Introspected tunnels to localhost 
 ### ”I want to expose a local server behind a NAT or firewall to the internet.”
 
+# Install
+
+Install supports **Linux** and **MacOS** with **homebrew**
+```bash
+brew install jerson/tap/pgrok
+```
+
+# Download
+just download in [Release section](https://github.com/jerson/pgrok/releases)
 
 ## What is pgrok?
 pgrok is a reverse proxy that creates a secure tunnel from a public endpoint to a locally running web service.