diff --git a/README.md b/README.md index cfa2b3b..ba3d77e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Inspired by [/r/startpages](https://www.reddit.com/r/startpages)—the idea is to have a homepage for your browser that is functional and sexy. -## Usage +## Basic Usage To go to a site, enter the corresponding key. To view the available sites and their keys, press `?`. If your input doesn't match any of the commands, a @@ -12,21 +12,21 @@ generic Google search will be triggered. For example: - Entering `r` would redirect you to [www.reddit.com](https://www.reddit.com). - Entering `t` would redirect you to [twitch.tv](https://www.twitch.tv). - Entering `cats` would search - [Google for cats](https://encrypted.google.com/search?q=cats). + [Google for "cats"](https://encrypted.google.com/search?q=cats). ### Searching -You can search any of the sites by typing a colon after the site's key, followed +You can search a site by typing a colon after the site's key, followed by your search query. For example: - Entering `g:tilde` would search [GitHub for tilde](https://github.com/search?q=tilde). -- Entering `s:radiohead` would search - [SoundCloud for radiohead](https://soundcloud.com/search?q=radiohead). +- Entering `s:san holo` would search + [SoundCloud for "san holo"](https://soundcloud.com/search?q=san%20holo). -### Specific Locations +### Specific Paths -You can go to a specific location on a site by typing a forward slash after the +You can go to a specific path on a site by typing a forward slash after the site's key, followed by the location on the site you'd like to be redirected to. For example: @@ -35,7 +35,7 @@ For example: - Entering `h/popular` would redirect you to [hypem.com/popular](http://hypem.com/popular). -### URL Redirects +### Specific Sites If you enter in a full domain or URL, you will be redirected to said domain or URL. For example: @@ -45,15 +45,6 @@ URL. For example: - Entering `https://smile.amazon.com` would redirect you to [smile.amazon.com](https://smile.amazon.com/). -### Query Parameter - -Additionally, you can pass any query via the `q` query param. For example: - -- Navigating to `file:///path/to/tilde/index.html?q=cats` would search - [Google for cats](https://encrypted.google.com/search?q=cats). - -This allows you to invoke Tilde with your native browser search bar. - ## Configuration The above is just the beginning. Open up the [index.html](index.html) file and