diff --git a/README.md b/README.md index 012b97f..721dc81 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,36 @@ Inspired by [/r/startpages](https://www.reddit.com/r/startpages)—the idea is t ## Usage -To go to a site, enter the corresponding key. To view the available sites, press `enter`. If your input doesn't match any of the commands, a generic google search will be triggered. +To go to a site, enter the corresponding key. To view the available sites and their keys, press `enter`. If your input doesn't match any of the commands, a generic Google search will be triggered. For example: -## Examples +* Entering `t` would redirect you to [twitter.com](https://twitter.com). +* Entering `r` would redirect you to [www.reddit.com](https://www.reddit.com). +* Entering `cats` would search [Google for cats](https://www.google.com/search?q=cats). -``` -t # takes you to Twitter -u/new # takes you to the new photos on Unsplash -r/r/unixporn # takes you to the unixporn subreddit -a: zen mind # searches Amazon for zen mind -cats # searches Google for cats -``` +### Searching -You get the idea... +You can search any of the sites by typing a colon after the site's key, followed by your search query. For example: + +* Entering `w: unix` would search [Wikipedia for unix](https://en.wikipedia.org/wiki/Unix). +* Entering `s: smash mouth` would search [SoundCloud for smash mouth](https://soundcloud.com/search?q=smash%20mouth). + +### Specific Locations + +You can go to a specific location 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: + +* Entering `r/r/unixporn` would redirect you to [www.reddit.com/r/unixporn](https://www.reddit.com/r/unixporn) +* Entering `u/new` would redirect you to [unsplash.com/new](https://unsplash.com/new). + +### URL Redirects + +If you enter in a full domain or URL, you will be redirected to said domain or URL. For example: + +* Entering `stallman.org` would redirect you to [stallman.org](https://stallman.org/). +* Entering `https://www.amazon.com` would redirect you to [www.amazon.com](https://www.amazon.com/). + +## Configuration + +There's a shlew of options that you can configure. Just open up the `index.html` file and read through them! ## Beyond