From 986a1b4a883a08944e16943a1d987a06b4f1a983 Mon Sep 17 00:00:00 2001 From: Simon Cambier Date: Sat, 19 Nov 2022 09:48:51 +0100 Subject: [PATCH] Updated README & CHANGELOG --- CHANGELOG.md | 7 +++++++ README.md | 17 ++++++++--------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 56da8e1..a37bff6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Omnisearch Changelog +## 1.8.x + +- Added OCR for images +- OCR and PDF indexing are now restricted to desktop. They either don't work or consume too much resources during indexing of big vaults. Too many headaches. +- Notes caching is deactivated on iOS because of crashes: memory usage too high during (de)serializing. +- Added an URL scheme for integration with external tools: `obsidian://omnisearch?query=foo bar` + ## 1.7.x ### New diff --git a/README.md b/README.md index dac4b58..258ce4e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-omnisearch) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/scambier/obsidian-omnisearch?include_prereleases&label=BRAT%20beta) -**Omnisearch** is a search engine that "_just works_". It always instantly shows you the most relevant results, thanks to its smart weighting algorithm. +> **Omnisearch** is a search engine that "_just works_". It always instantly shows you the most relevant results, thanks to its smart weighting algorithm. Under the hood, it uses the excellent [MiniSearch](https://github.com/lucaong/minisearch) library. @@ -14,27 +14,26 @@ Under the hood, it uses the excellent [MiniSearch](https://github.com/lucaong/mi ## Features -- Find your notes faster than ever - - Workflow similar to the "Quick Switcher" core plugin +> Omnisearch's first goal is to _locate_ files instantly. You can see it as a _Quick Switcher_ on steroids. + +- Find your **📝notes, 📄PDFs, and 🖼images** faster than ever + - _Images OCR and PDF indexing are only available on desktop_ - Automatic document scoring using the [BM25 algorithm](https://github.com/lucaong/minisearch/issues/129#issuecomment-1046257399) - The relevance of a document against a query depends on the number of times the query terms appear in the document, its filename, and its headings -- Can search other plaintext files and PDFs - - Opt-in in settings - - PDF indexing is disabled on iOS - Keyboard first: you never have to use your mouse +- Workflow similar to the "Quick Switcher" core plugin - Resistance to typos - Switch between Vault and In-file search to quickly skim multiple results in a single note - Supports `"expressions in quotes"` and `-exclusions` - Directly Insert a `[[link]]` from the search results -- Respects Obsidian's "Excluded Files" list - results are downranked, not hidden -- Supports Vim navigation keys (ctrl + j, k, n, p) +- Supports Vim navigation keys **Note:** support of Chinese, Japanese, Korean, etc. depends on [this additional plugin](https://github.com/aidenlx/cm-chs-patch). Please read its documentation for more information. ## Installation - Omnisearch is available on [the official Community Plugins repository](https://obsidian.md/plugins?search=Omnisearch). -- Beta releases can be installed through [BRAT](https://github.com/TfTHacker/obsidian42-brat). **Be advised that those versions can be buggy.** +- Beta releases can be installed through [BRAT](https://github.com/TfTHacker/obsidian42-brat). **Be advised that those versions can be buggy and break things.** You can check the [CHANGELOG](./CHANGELOG.md) for more information on the different versions.