Browse Source

update package.json, add readme

main
Mikey Oz 3 years ago
parent
commit
d74d06ebd2
  1. 7
      package.json
  2. 35
      readme.md

7
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",

35
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.
Loading…
Cancel
Save