Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
psidex committed Mar 19, 2023
1 parent d0a8899 commit bbb27e6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@

A browser extension to use custom DuckDuckGo-like bangs directly from the address bar.

## Example Searches
```
!a monitor ▶ https://www.amazon.co.uk/s?k=monitor
!r G273QF ▶ https://www.google.com/search?q=site%3Areddit.com+G273QF
!m new york ▶ https://www.google.com/maps/search/new%20york
!y boids ▶ https://www.youtube.com/results?search_query=boids
```

## Demo

TODO: New, good demo. Video and basic explainer image.
Expand All @@ -26,6 +34,10 @@ Bangs will also work by just using the search engines normally.

## Options Page

The bang editing menu and general options are accessed using the extensions options page:

![options page screenshot](./images/options-page.png)

All of your bangs and options are saved to the browsers sync storage, meaning if you log into your browser they will sync across to wherever else you are logged in.

This storage has a strict quota, and you can see the amount of it you are using at the top of the options page.
Expand All @@ -51,7 +63,7 @@ If the save button is highlighted green, this means you have unsaved changes and

### Options

A options tab exists within the options page, which allows you to change the behaviour of the extension.
An options tab exists within the options page, which allows you to change the behaviour of the extension.

Currently this is just the search engines that the extension is enabled to use bangs with.

Expand Down
Binary file added images/options-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bbb27e6

Please sign in to comment.