From 7710d7a06c0f820e66ad1d9930ed182938068423 Mon Sep 17 00:00:00 2001 From: imdj Date: Mon, 12 Feb 2024 14:58:05 +0200 Subject: [PATCH] Imrpove README: Add badges and announce support for firefox Android --- README.md | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f5cf2d8..a0a240f 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,40 @@
preview of the relevant submissions section on hacker news
+![Chrome Web Store](https://img.shields.io/chrome-web-store/v/iajhnkeiioebplnbfkpnlnggkgblmoln?logo=googlechrome&logoColor=000000&labelColor=F3F3F3&color=4285F4) +![Mozilla Add-on Stars](https://img.shields.io/amo/v/hnrelevant?logo=firefoxbrowser&logoColor=FFFFFF&labelColor=2E1068&color=F5541F) + # HNRelevant A lightweight browser extension that augments your Hacker News experience by showing related submissions to the one you're viewing. It helps you immerse yourself in interesting discussions and uncover overlooked gems. -### Features +## Features - Related submissions ready to be explored - Two modes: - Automatic: Enjoy a seamless experience with results generated upon page load - Manual: Search only when desired - The result blends naturally with Hacker News's interface and match its look and feel +- Available on Firefox for Android™ - Manageable preferences via the extension's popup in the browser toolbar -### How it works -It's based on [HN algolia search API](https://hn.algolia.com/api) and uses the submission title as its initial query - -### How to install -#### Google Chrome: -Available on Chrome web store: [HNRelevant](https://chrome.google.com/webstore/detail/hnrelevant/iajhnkeiioebplnbfkpnlnggkgblmoln) +## Installation +
+ + HNRelevant on Chrome Web Store + + + HNRelevant on Firefox add-ons + +
-#### Firefox: -Firefox add-on: [HNRelevant](https://addons.mozilla.org/en-US/firefox/addon/hnrelevant/) +Available on: +- **Chrome web store**: [HNRelevant](https://chrome.google.com/webstore/detail/hnrelevant/iajhnkeiioebplnbfkpnlnggkgblmoln) +- **Firefox (Desktop & Android) add-on**: [HNRelevant](https://addons.mozilla.org/en-US/firefox/addon/hnrelevant/) +- As a **Userscript**. This option also has the benefit of supporting further browsers: + 1. Make sure to have one of the userscripts extensions installed e.g: Tampermonkey, Violentmonkey, or Greasemonkey. + 2. The userscript file can be found here [HNRelevant.user.js](https://github.com/imdj/HNRelevant/raw/main/HNRelevant.user.js). + 3. Load the script into the extension of your choice. -#### Userscript: -You can run it on other browsers using a userscript extensions like: Tampermonkey, Violentmonkey, or Greasemonkey. -1. Make sure to have one of the userscripts extensions installed -2. Save the userscript file from [here](https://github.com/imdj/HNRelevant/raw/main/HNRelevant.user.js). -3. Load the script into the extension of your choice. +## How it works +It's based on [HN algolia search API](https://hn.algolia.com/api) and uses the submission title as its initial query -### License -Released under the [MIT License](http://www.opensource.org/licenses/MIT). See [LICENSE](LICENSE) file for details. \ No newline at end of file +## License +Released under the [MIT License](http://www.opensource.org/licenses/MIT). See [LICENSE](LICENSE) file for details.