Add installation instructions to README

Co-authored-by: aider (gemini/gemini-2.5-pro) <aider@aider.chat>

README.md

@@ -1,23 +1,83 @@
-# Omnisearch for Obsidian
+# Tannersearch for Obsidian
 
-[![Sponsor me](https://img.shields.io/badge/%E2%9D%A4%20Like%20this%20plugin%3F-Sponsor%20me!-ff69b4)](https://github.com/sponsors/scambier)  
+This is a fork of [obsidian-omnisearch](https://github.com/scambier/obsidian-omnisearch) (by [@scambier](https://github.com/scambier)) with the following changes:
-![Obsidian plugin](https://img.shields.io/endpoint?url=https%3A%2F%2Fscambier.xyz%2Fobsidian-endpoints%2Fomnisearch.json)
-![GitHub release (latest by date and asset)](https://img.shields.io/github/downloads/scambier/obsidian-omnisearch/latest/main.js)  
-![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)
 
-> 🏆 Winner of the _[2023 Gems of the Year](https://obsidian.md/blog/2023-goty-winners/)_ in the "Existing plugin" category 🏆
+When opening a result, the cursor placement prioritizes note titles over headings over content
+- this means if the note's name matches your search, it opens at the top instead of on a random match in the middle of the note
+
+Search terms aren't split on apostrophes
+- searching for "Sun's BBQ" searches for ["Sun's", "BBQ"] instead of ["Sun", "s", "BBQ"]
+
+Search terms less than 3 characters long or common words are ignored
+- ignored words: "a", "an", "the", "and", "or", "but", "if", "in", "on", "at", "by", "for", "with", "to", "from", "of", "is", "it", "that", "this"
+
+The first line of a paragraph is ranked like Heading 3 if it ends in a colon
+- for example,
+
+```
+Japan trip:
+- passport
+- cash
+- umbrella
+```
+
+... "Japan trip:" is indexed and ranked the same as "### Japan trip"
+
+If the first paragraph of a note contains a line like "aka other name", then "other name" is ranked like H1
+- for example,
+
+```
+see also: [[Travel General]]
+Aka: packing list
+
+content
+```
+
+... "packing list" is indexed and ranked the same as "# packing list". Note that "Aka:" isn't case or colon sensitive.
 
 
----
+### Fork Installation
+
+Ensure the original Omnisearch plugin is installed, see instructions below.
+
+Download main.js into your `.obsidian/plugins/omnisearch` directory, example:
+
+```
+$ cd ~/notes/.obsidian/plugins/omnisearch
+$ mv main.js main.js.bak
+$ wget https://raw.githubusercontent.com/tannercollin/obsidian-tannersearch/refs/heads/master/dist/main.js
+```
+
+In Obsidian, open Settings > Community Plugings. Disable and enable Omnisearch.
+
+Open Settings > Omnisearch. Scroll to bottom. Click "Clear cache" data.
+
+Restart Obsidian.
+
+Note: on mobile you'll have to use some sort of sync or downloader and move the main.js over to your vault.
+
+### Building the Fork
+
+If you'd rather build the fork yourself:
+
+```
+$ git clone https://github.com/tannercollin/obsidian-tannersearch.git
+$ cd obsidian-tannersearch/
+$ npm install --legacy-peer-deps
+$ npm run build
+```
+
+Then copy `dist/main.js` as above.
+
+
+
+# Original README
 
 **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. This free plugin is totally unrelated to the omnisearch.ai paid product.
 
-![](https://raw.githubusercontent.com/scambier/obsidian-omnisearch/master/images/omnisearch.gif)
-
 ## Documentation
 
 https://publish.obsidian.md/omnisearch/Index
@@ -72,5 +132,3 @@ Omnisearch is licensed under [GPL-3](https://tldrlegal.com/license/gnu-general-p
 
 To all people who donate through [Ko-Fi](https://ko-fi.com/scambier)
 or [Github Sponsors](https://github.com/sponsors/scambier) ❤
-
-![JetBrains logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)

src/repositories/documents-repository.ts

@@ -233,6 +233,12 @@ export class DocumentsRepository {
     const headings2 = metadata ? extractHeadingsFromCache(metadata, 2) : []
     const headings3 = metadata ? extractHeadingsFromCache(metadata, 3) : []
 
+    const akaHeadings: string[] = content
+      .split(/\n\s*\n/)[0]
+      .split('\n')
+      .map(line => line.match(/^aka:?\s*(.+)$/i)?.[1]?.trim())
+      .filter((heading): heading is string => !!heading)
+
     const lines = content.split('\n')
     const colonHeadings: string[] = []
     for (let i = 0; i < lines.length; i++) {
@@ -263,7 +269,7 @@ export class DocumentsRepository {
       tags: tags,
       unmarkedTags: tags.map(t => t.replace('#', '')),
       aliases: getAliasesFromMetadata(metadata).join(''),
-      headings1: headings1.join(' '),
+      headings1: [...headings1, ...akaHeadings].join(' '),
       headings2: headings2.join(' '),
       headings3: [...headings3, ...colonHeadings].join(' '),
     }