From d74d06ebd2c211048f30bbca4aacddcf07ffd18b Mon Sep 17 00:00:00 2001
From: Mikey Oz <ozmichaelt@icloud.com>
Date: Mon, 2 May 2022 16:08:29 -0700
Subject: [PATCH] update package.json, add readme

---
 package.json |  7 +++++--
 readme.md    | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 readme.md

diff --git a/package.json b/package.json
index d72e813..a4f2544 100644
--- a/package.json
+++ b/package.json
@@ -1,8 +1,11 @@
 {
 	"name": "fuzzyhome",
 	"scripts": {
-		"start": "imba -w server.imba",
-		"build": "imba build server.imba"
+		"start": "imba run --baseurl . -w server.imba",
+		"build": "imba build --baseurl . server.imba",
+		"nojekyll": "npx touch dist/public/.nojekyll",
+		"pages": "npx gh-pages --no-history --dotfiles --dist dist/public",
+		"deploy": "npm run build && npm run nojekyll && npm run pages"
 	},
 	"dependencies": {
 		"express": "^4.17.1",
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..d6ab49b
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,35 @@
+# fuzzyhome
+
+A new-tab page [hosted](https://bread.quest/fuzzyhome/) on github pages
+that lets you fuzzy find links and quickly navigate to the top result.
+
+## Installation
+On Firefox, unfortunately you can't choose a custom new-tab page,
+so I opted to use [this addon](https://addons.mozilla.org/en-US/firefox/addon/new-tab-override)
+and chose `https://bread.quest/fuzzyhome/` as the custom url.
+
+## Usage
+
+### Create
+Create a new link by typing a name and a url separated by a space.
+For example:
+```
+imba home page https://imba.io/
+```
+The last space-separated string will be used as the url for your link.
+
+### Search
+Search your links by focusing the search bar and typing.
+The fuzzy sorting algorithm makes searching very fast,
+as you can usually just type the first letter of each word to get to a link (`ihp` to get to `imba home page`, for example).
+
+### Navigate
+Navigate to the topmost search result by pretting `return`.
+
+### Hotkeys
+Hotkey | Action
+-|-
+Return | Navigate to the topmost link, if any.
+Shift + Return | Perform a Google search with search bar text.
+CMD + K | Focus search bar.
+Esc | Blur search bar.