From c8fc733ab04cb4dfee5567e44b91bd47d7ad14c0 Mon Sep 17 00:00:00 2001 From: ator-dev Date: Fri, 2 Aug 2024 23:48:01 +0100 Subject: [PATCH 1/2] Improve README Optimise the new README for concision and readability. --- README.md | 54 ++++++++++++++++++++++-------------------------------- 1 file changed, 22 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 28261ff..0142e24 100644 --- a/README.md +++ b/README.md @@ -2,50 +2,40 @@ *Mark My Search* is a browser extension that finds and highlights phrases. -It takes inspiration from many other extensions, including the now legendary SearchWP add-on for Firefox. +It takes inspiration from many other extensions, including the legacy SearchWP add-on for Firefox. -**Some of the ways you can use it:** +## Common uses -* A replacement for the browser's find-in-page function (`Ctrl`/`Cmd` + `F`). - * *Mark My Search*'s highlighting stays up to date on pages with infinite scrolling and other dynamic content. - * You can search for multiple keywords at once. - * You can edit advanced matching options for each keyword: - Case sensitivity; Whole words only; [Stemming](https://en.wikipedia.org/wiki/Stemming) mode; [Diacritics](https://en.wikipedia.org/wiki/Diacritic) sensitivity; **[Regex](https://en.wikipedia.org/wiki/Regular_expression) mode**. - -* Finding the relevant parts of a page you visited from web search. - * *Mark My Search* highlights keywords from online searches automatically. This setting is on by default, but it can be changed from the startpage or popup. +Occurrences are marked in the scrollbar. You can step through them by clicking on a keyword in *Mark My Search*'s toolbar. Keyboard shortcuts are supported for all actions, but how you view and edit them depends on the browser. -* Highlighting a set of keywords on certain websites. - * *Mark My Search* can store lists of keywords and highlight them automatically on certain websites. - * You can configure this in the "Keyword Lists" section of the popup. +**A replacement for the browser's find-in-page (`Ctrl`/`Cmd` + `F`):** -**Common problems:** +* *Mark My Search*'s highlighting stays up-to-date on pages with infinite scrolling and other dynamic content. +* You can search for multiple keywords at once. +* You can edit matching options for each keyword: + case sensitivity, whole words only, [stemming](https://en.wikipedia.org/wiki/Stemming) mode, [diacritics](https://en.wikipedia.org/wiki/Diacritic) sensitivity, and **[regex](https://en.wikipedia.org/wiki/Regular_expression) mode**. -* On pages which change frequently, *Mark My Search* can cause slowdown. -* Very many highlights can cause slowdown. -* Some pages, especially ones with a lot of Javascript, respond poorly to *Mark My Search*'s highlighting. NOTE: This is a fixable issue that is being worked on! - - -## On-page components - -* Toolbar (control buttons, keyword controls, add-keyword control) - * Keyword counts - * Keyword jumping / stepping -* Highlighting -* Scrollbar markers +**Finding the relevant parts of a page visited from web search:** +* *Mark My Search* highlights keywords from online searches automatically. This setting is on by default, but it can be changed from the startpage or popup. -## Compatibility +**Highlighting a set of keywords on certain websites:** -**Mark My Search** is fully cross-browser. The source is designed to produce the same experience across all *modern* browsers based on Firefox or Chromium. Currently it is tested against the most recent releases. +* *Mark My Search* can store lists of keywords and highlight them automatically on certain websites. +* You can configure this in the "Keyword Lists" section of the popup. -* The `main` branch uses Manifest V3 and supports recent Firefox and Chromium versions. -* The `manifest-v2` branch uses Manifest V2 and contains the source for Firefox releases of *Mark My Search*. It will be **deprecated soon** in favour of Manifest V3 on both browsers. -* Safari is unsupported as I do not have access to an Apple computer. +## Common problems +* On pages which change frequently, *Mark My Search* can cause slowdown. +* Very many highlights can cause slowdown. +* Some pages, especially ones with a lot of Javascript, respond poorly to *Mark My Search*'s highlighting. NOTE: This is a fixable issue that is being worked on! -## Store Listings +## Store listings * [Firefox Browser Add-ons](https://addons.mozilla.org/en-GB/firefox/addon/mark-my-search/) * [Chrome Web Store](https://chrome.google.com/webstore/detail/mark-my-search/lijbnhoniejpjjgemoifpjklobhakinb) * [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/mark-my-search/pgkppfodndbpalojpibdnlcdfcnidemj) + +## Development + +NOTE: This section will contain a link to the website, which is planned to host all documentation. From c15d0f8f92ffbd3391a127b78c43c49d43848c75 Mon Sep 17 00:00:00 2001 From: ator-dev Date: Sat, 3 Aug 2024 22:17:06 +0100 Subject: [PATCH 2/2] Use (idiomatic) italics for "Mark My Search" --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0142e24..3eae960 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,34 @@ # Mark My Search -*Mark My Search* is a browser extension that finds and highlights phrases. +Mark My Search is a browser extension that finds and highlights phrases. It takes inspiration from many other extensions, including the legacy SearchWP add-on for Firefox. ## Common uses -Occurrences are marked in the scrollbar. You can step through them by clicking on a keyword in *Mark My Search*'s toolbar. Keyboard shortcuts are supported for all actions, but how you view and edit them depends on the browser. +Occurrences are marked in the scrollbar. You can step through them by clicking on a keyword in Mark My Search's toolbar. Keyboard shortcuts are supported for all actions, but how you view and edit them depends on the browser. **A replacement for the browser's find-in-page (`Ctrl`/`Cmd` + `F`):** -* *Mark My Search*'s highlighting stays up-to-date on pages with infinite scrolling and other dynamic content. +* Mark My Search's highlighting stays up-to-date on pages with infinite scrolling and other dynamic content. * You can search for multiple keywords at once. * You can edit matching options for each keyword: case sensitivity, whole words only, [stemming](https://en.wikipedia.org/wiki/Stemming) mode, [diacritics](https://en.wikipedia.org/wiki/Diacritic) sensitivity, and **[regex](https://en.wikipedia.org/wiki/Regular_expression) mode**. **Finding the relevant parts of a page visited from web search:** -* *Mark My Search* highlights keywords from online searches automatically. This setting is on by default, but it can be changed from the startpage or popup. +* Mark My Search highlights keywords from online searches automatically. This setting is on by default, but it can be changed from the startpage or popup. **Highlighting a set of keywords on certain websites:** -* *Mark My Search* can store lists of keywords and highlight them automatically on certain websites. +* Mark My Search can store lists of keywords and highlight them automatically on certain websites. * You can configure this in the "Keyword Lists" section of the popup. ## Common problems -* On pages which change frequently, *Mark My Search* can cause slowdown. +* On pages which change frequently, Mark My Search can cause slowdown. * Very many highlights can cause slowdown. -* Some pages, especially ones with a lot of Javascript, respond poorly to *Mark My Search*'s highlighting. NOTE: This is a fixable issue that is being worked on! +* Some pages, especially ones with a lot of Javascript, respond poorly to Mark My Search's highlighting. NOTE: This is a fixable issue that is being worked on! ## Store listings