update readme

This commit is contained in:
Cade Scroggins 2021-01-20 14:13:39 +05:30
parent be23cad97f
commit 0250e4555c
No known key found for this signature in database
GPG key ID: 6AC5A902158265D0
2 changed files with 28 additions and 33 deletions

View file

@ -1,54 +1,49 @@
# Tilde
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.
is to have a browser homepage that is functional and sexy.
## Basic Usage
## 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 keys, a
generic Google search will be triggered.
This is how you can use Tilde out of the box, but it’s
[meant to be customized](index.html).
- Entering `t` would redirect you to [twitter.com](https://twitter.com/home).
- Entering `u` would redirect you to
[unsplash.com](https://unsplash.com/images).
- Entering `duckduckgo` would
- 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 an 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).
- Entering `duckduckgo` will
[search Google for duckduckgo](https://www.google.com/search?q=duckduckgo).
### Searching
#### Searching
Search a site by typing a single quote after the site’s key, followed by
your query.
- Entering `g'tilde` would
- Entering `g'tilde` will
[search GitHub for tilde](https://github.com/search?q=tilde).
- Entering `y'vox` would
- Entering `y'vox` will
[search YouTube for vox](https://www.youtube.com/results?search_query=vox).
### Specific Paths
#### Specific Paths
Go to a specific location on a site by typing a forward slash after the
site’s key, followed by a path.
- 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
- Entering `r/r/startpages` will redirect you to
[reddit.com/r/startpages](https://www.reddit.com/r/startpages)
- Entering `h/popular` will redirect you to
[hypem.com/popular](http://hypem.com/popular).
### Specific Sites
#### Other Sites
Enter a full domain or URL to be redirected to said domain or URL.
- Entering `stallman.org` would redirect you to
- Entering `stallman.org` will redirect you to
[stallman.org](https://stallman.org/).
- Entering `https://smile.amazon.com` would redirect you to
- Entering `https://smile.amazon.com` will redirect you to
[smile.amazon.com](https://smile.amazon.com/).
### Beyond
The above is just the beginning… Open up the [index.html](index.html)
file and make it yours!
## License
Feel free to use and modify Tilde

View file

@ -28,7 +28,7 @@
// is used. Commands without a category don't show up in the help menu.
// You can specify either "hues" or "color" to change a command's background
// color. "hues" is an array of CSS HSL hues that will be converted into a
// color. "hues" is an array of HSL hues that will be converted into a
// linear gradient. There are CSS variables defined below, prefixed with
// "--command-color-", that determine the gradient angle, saturation,
// lightness and alpha for each generated color. "color", if defined, will