Merge pull request #47 from mogenson/update-readme

Update Readme with SpoonInstall instructions
mogenson · May 22, 2024 · daf17f3 · daf17f3
2 parents 6ef95b9 + 79c0231
commit daf17f3
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
diff --git a/README.md b/README.md
@@ -19,6 +19,27 @@ Spaces".
 
 <img width="780" alt="Screen Shot 2022-01-07 at 14 10 11" src="https://user-images.githubusercontent.com/900731/148595715-1f7a3509-1289-4d10-b64d-86b84c076b43.png">
 
+### Install with [SpoonInstall](https://www.hammerspoon.org/Spoons/SpoonInstall.html)
+
+```lua
+hs.loadSpoon("SpoonInstall")
+
+spoon.SpoonInstall.repos.PaperWM = {
+    url = "https://github.com/mogenson/PaperWM.spoon",
+    desc = "PaperWM.spoon repository",
+    branch = "release",
+}
+
+spoon.SpoonInstall:andUse("PaperWM", {
+    repo = "PaperWM",
+    config = { screen_margin = 16, window_gap = 2 },
+    start = true,
+    hotkeys = {
+		< see below >
+    }
+})
+```
+
 ## Usage
 
 Add the following to your `~/.hammerspoon/init.lua`:

diff --git a/docs/docs.json b/docs/docs.json
@@ -1,6 +1,6 @@
 [
   {
     "name": "PaperWM",
-    "desc": "A package to enable a PaperWM like window management style"
+    "desc": "Tiled scrollable window manager for MacOS. Inspired by PaperWM."
   }
 ]