tilde/README.md
2022-04-26 19:44:38 -07:00

50 lines
1.6 KiB
Markdown

# Tilde
Inspired by [r/startpages](https://www.reddit.com/r/startpages)—the idea
is to have a browser homepage that is functional and sexy.
## Basic Usage
This is how you can use Tilde out of the box, but it’s
[meant to be customized](index.html).
- To go to a site, type the corresponding key and press return.
- To view the available sites and their keys, type a question mark.
- If your input doesn’t match a key, a generic Google search will be
triggered.
- To search a site, type a single quote after the site’s key, followed by
your query.
- To go to a specific path on a site, type the path after the site’s key.
### Examples
- Entering `t` will redirect you to [twitter.com](https://twitter.com/home).
- Entering `u` will redirect you to [unsplash.com](https://unsplash.com/images).
#### Searching
- Entering `anything` will
[search Google for anything](https://www.google.com/search?q=anything).
- Entering `g'tilde` will
[search GitHub for tilde](https://github.com/search?q=tilde).
- Entering `y'vox` will
[search YouTube for vox](https://www.youtube.com/results?search_query=vox).
#### Specific Paths
- Entering `r/r/startpages` will redirect you to
[r/startpages](https://www.reddit.com/r/startpages).
- Entering `j/popular` will redirect you to
[hypem.com/popular](http://hypem.com/popular).
#### Other Sites
- Entering `stallman.org` will redirect you to
[stallman.org](http://stallman.org/).
- Entering `https://xvvvyz.xyz` will redirect you to
[xvvvyz.xyz](https://xvvvyz.xyz).
## License
Thank you for reading! Feel free to use and modify Tilde
[as you see fit](LICENSE).