foo/tilde
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Cade Scroggins
2019-04-17 14:09:57 -07:00
parent 9277269f52
commit 6bdef8297e
1 changed files with 8 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -17
View File
@@ -3,7 +3,7 @@
Inspired by [/r/startpages](https://www.reddit.com/r/startpages)—the idea is to 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. 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 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 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 `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 `t` would redirect you to [twitch.tv](https://www.twitch.tv).
- Entering `cats` would search - 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 ### 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: by your search query. For example:
- Entering `g:tilde` would search - Entering `g:tilde` would search
[GitHub for tilde](https://github.com/search?q=tilde). [GitHub for tilde](https://github.com/search?q=tilde).
- Entering `s:radiohead` would search - Entering `s:san holo` would search
[SoundCloud for radiohead](https://soundcloud.com/search?q=radiohead). [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. site's key, followed by the location on the site you'd like to be redirected to.
For example: For example:
@@ -35,7 +35,7 @@ For example:
- Entering `h/popular` would redirect you to - Entering `h/popular` would redirect you to
[hypem.com/popular](http://hypem.com/popular). [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 If you enter in a full domain or URL, you will be redirected to said domain or
URL. For example: URL. For example:
@@ -45,15 +45,6 @@ URL. For example:
- Entering `https://smile.amazon.com` would redirect you to - Entering `https://smile.amazon.com` would redirect you to
[smile.amazon.com](https://smile.amazon.com/). [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 ## Configuration
The above is just the beginning. Open up the [index.html](index.html) file and The above is just the beginning. Open up the [index.html](index.html) file and