update

tom-on-the-internet · Nov 3, 2023 · b748ab7 · b748ab7
1 parent 46bc17a
commit b748ab7
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -15,11 +15,11 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Build
+      - name: Build and Run # make sure it runs
         run: |
           go version
           go build .
-          ./cemetery-escape help # make sure it runs
+          ./cemetery-escape help
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5
         if: startsWith(github.ref, 'refs/tags/')

diff --git a/README.md b/README.md
@@ -12,6 +12,20 @@ but watch out for ghosts.
 - A [Nerd Font](https://www.nerdfonts.com/)
 - A dark color scheme terminal
 
+## Installation
+
+### Using Go
+
+Run
+
+```sh
+go install github.com/tom-on-the-internet/cemetery-escape@latest
+```
+
+### Get the Binary
+
+Look in the [releases](https://github.com/tom-on-the-internet/cemetery-escape/releases/latest) for a binary that runs on your hardware.
+
 ## TODO
 
 - string builder size