Skip to content

Commit

Permalink
Bump version to 1.3.0 and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Fivefold committed Mar 21, 2023
1 parent ead59ed commit 44ef1a5
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 5 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,17 @@ Community browser extension for the self-hosted [linkding](https://github.com/si

**Features**
- When searching on a search engine the search term is also sent to your linkding instance and results are added in a new box in the sidebar right to the search engine results.
- Supports [google](https://www.google.com/) and [duckduckgo](https://duckduckgo.com/) search engines
- Supports the following search engines:
- [google](https://www.google.com/)
- [duckduckgo](https://duckduckgo.com/)
- [SearX/SearXNG](https://duckduckgo.com/)*
- [Brave Search](https://search.brave.com/)
- Automatic light or dark theme detection

Works with: Firefox, Chrome

_\* experimental, please read [this](docs/searx.md) if you have problems_

**Usage**

After installation the extension needs to be configured and connected to your linkding instance. Either open the extension options in the browser extension manager or follow the link in the new linkding injector box on the search page of google or duckduckgo.
Expand Down
17 changes: 17 additions & 0 deletions docs/searx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
**SearX/SearXNG support**

This extension includes experimental support for self-hosted SearX/SearXNG instances. To work, your instance must follow either of these URL patterns: `*://*/search?*`, `*://*/search`

Examples that work:
- `https://search.mywebsite.com/search`
- `https://search.mywebsite.com/search?q=searchTerm`
- `http://mysearch.local/search`

Examples that *don't* work:
- `https://search.mywebsite.com/`
- `http://mywebsite.com/searx/`
- `http://mywebsite.com/searx/search`

Also, nothing might be injected if you don't use the default "simple" theme.

If you have the correct URL, you see a linkding injector box in other supported search engines (e.g. google) but not in your SearX instance, please see if someone already [mentioned your issue](https://github.com/Fivefold/linkding-injector/issues) on github and if not, [create an issue](https://github.com/Fivefold/linkding-injector/issues/new/choose).
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"manifest_version": 2,
"name": "linkding injector",
"version": "1.2.0",
"version": "1.3.0",
"description": "Injects search results from the linkding bookmark service into search pages like google and duckduckgo",
"homepage_url": "https://github.com/fivefold/linkding-injector.git",

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "linkding-injector",
"version": "1.2.0",
"version": "1.3.0",
"description": "Injects search results from the linkding bookmark service into search pages like google and duckduckgo",
"license": "MIT",
"author": "Jakob Essbüchl",
Expand Down

0 comments on commit 44ef1a5

Please sign in to comment.