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

small changes + fix from #18

Browse Source
This commit is contained in:
Cade Scroggins
2018-10-09 12:15:49 -07:00
parent 692d8a3041
commit 380d9d92d1
2 changed files with 95 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -10
View File
@@ -8,9 +8,9 @@ Inspired by [/r/startpages](https://www.reddit.com/r/startpages)—the idea is t
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 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).
- 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).
On mobile, you can click the clock to focus the search input.
@@ -18,26 +18,34 @@ On mobile, you can click the clock to focus the search input.
You can search any of the sites 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 `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).
### 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/startpages` would redirect you to [www.reddit.com/r/startpages](https://www.reddit.com/r/startpages)
* Entering `h/popular` would redirect you to [hypem.com/popular](http://hypem.com/popular).
- Entering `r/r/startpages` would redirect you to [www.reddit.com/r/startpages](https://www.reddit.com/r/startpages)
- Entering `h/popular` would redirect you to [hypem.com/popular](http://hypem.com/popular).
### 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://smile.amazon.com` would redirect you to [smile.amazon.com](https://smile.amazon.com/).
- Entering `stallman.org` would redirect you to [stallman.org](https://stallman.org/).
- Entering `https://smile.amazon.com` would redirect you to [smile.amazon.com](https://smile.amazon.com/).
### Query Paramater
Additionally, you can pass any query via the `q` query param. For example:
- Going 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 read through the `CONFIG`!
The above is _just the beginning_. Open up the [index.html](index.html) file and read through the `CONFIG`!
## License