prehistoric-systems/tilde
1
0
Fork 0
mirror of https://github.com/xvvvyz/tilde.git synced 2026-03-11 14:44:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Cade Scroggins 2018-12-16 04:02:54 -08:00
parent e3cf71f1dc
commit 41764b5ddb
1 changed files with 30 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -2,54 +2,68 @@
> Minimal browser startpage.
![Screenshot](SCREENSHOT.png?raw=true 'Screenshot')
## What
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.
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
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:
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 `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.
### Searching
You can search any of the sites by typing a colon after the site's key, followed by your search query. For example:
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:
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:
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).
- 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