improved default index, more readme

progrium · Mar 14, 2021 · 07a9b5f · 07a9b5f
1 parent 9eafa0d
commit 07a9b5f
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 36 deletions.
diff --git a/.goreleaser.yml b/.goreleaser.yml
diff --git a/Makefile b/Makefile
@@ -1,9 +1,3 @@
 
 build:
 	go build -o local/topframe .
-
-release:
-	goreleaser --snapshot --skip-publish --rm-dist
-
-clean:
-	rm -rf ./dist
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ User programmable screen overlay using web technologies
 <a href="https://github.com/sponsors/progrium" title="Sponsor Project"><img src="https://img.shields.io/static/v1?label=sponsor&message=%E2%9D%A4&logo=GitHub" alt="Sponsor Project" /></a>
 
 ---
-* Display information or place always-on-top widgets
+* Display information or always-on-top widgets
 * Use HTML/JS/CSS to draw on your screen
 * Great for screencasting or streaming overlays
 * Edit source, hit save, screen will update
@@ -18,8 +18,31 @@ User programmable screen overlay using web technologies
 
 ## Getting Started
 
- * download or run shell command
- * run with edit flag `topframe --edit`
+First, [download Go](https://golang.org/dl/) or `brew install go`. If you have Go installed, make sure it is 
+version 1.16 or greater:
+
+```
+$ go version
+go version go1.16.2 darwin/amd64
+```
+
+Then use `go get` to download, build, and install the topframe binary into a `PATH` directory:
+
+```
+$ GOBIN=/usr/local/bin go get github.com/progrium/topframe
+```
+
+Currently, this is the preferred way to install as anything else requires a much more elaborate
+release process with Apple code signing, etc. Specifying `GOBIN` is optional, but lets you specify
+where to install the binary, ensuring it is put in a directory in your `PATH`. 
+
+Running `topframe` will create a `~/.topframe` directory with a default `index.html` used for the
+overlay. If you have an `EDITOR` specified, you can run with `-edit` to open this in your preferred editor
+so you can start making changes to your topframe overlay immediately:
+
+```
+$ topframe -edit
+```
 
 ### Launching on Startup
 
@@ -52,4 +75,6 @@ in the right place before generating, or modify the plist file.
 
 ## About
 
+Topframe started as a 130 line example for [progrium/macdriver](https://github.com/progrium/macdriver).
+
 MIT Licensed
diff --git a/index.html b/index.html
@@ -2,9 +2,11 @@
 <head>
   <link rel="stylesheet" href="https://unpkg.com/tailwindcss@^2/dist/tailwind.min.css" />
 </head>
-<body class="border-2 border-purple-500 text-white">
-    <div class="w-96 h-64 m-8 absolute right-0 rounded p-4 bg-purple-500">
-      <h2 class="text-3xl my-4 text-center animate-bounce">Hello!</h2>
+<body class="flex justify-center">
+    <div class="w-96 bg-purple-500 bg-opacity-50 absolute bottom-0 m-8 p-4 rounded">
+      <h2 class="text-center text-white text-3xl my-4 animate-bounce">
+        Hello world!
+      </h2>
     </div>
 </body>
 </html>