From 48256c896a9eadb8b679fedcf365483443aa07ca Mon Sep 17 00:00:00 2001 From: Mitesh Shah Date: Tue, 11 Aug 2020 23:55:12 +0530 Subject: [PATCH] docs: update readme with firefox add-on link also added description from the addon page --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 668b711..d9d4b92 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,25 @@ ![image](https://user-images.githubusercontent.com/19304/89511791-fcffce80-d7ef-11ea-9d2e-e2557d77a9b3.png) -This is a browser extensions that recommends better alternatives to products and service that you're currently visiting. "Better" could mean ethical or cheaper or local or higher-quality or something else. So, while we ship a default list, users will be able to subscribe to multiple sources for recommendations. +This extension looks at your current URL, and recommends "better" product/service alternatives via an in-page pop-up. "Better" could mean ethical / privacy-conscious / secure / local / cheaper / high-quality etc. -This is a work-in-progress and not yet published. This should work for both Chromium-based (Chrome, Brave, Chromium etc) AND Firefox-based browsers. +This is a work-in-progress. This should work for both Chromium-based (Chrome, Brave, Chromium etc) AND Firefox-based browsers. + +# Installation + +[Download on Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/better-alternatives/) + +Chrome Webstore: Coming soon + +# Philosophy + +The idea is to encourage competition and consumer choice. Our default list of alternatives is built from sources like https://switching.software/ and https://prism-break.org/en/ + +The extension ships with a default list of recommendations but you can subscribe to lists maintained by others. This allows different interpretations of "better" to exist and you can subscribe to those that appeals to your preferences the most. + +For every URL pattern, multiple alternatives may exist. The first one is always shown as a primary recommendation with emphasis, and the rest are presented as secondary. + +The pop-up shows an option to dismiss the suggestion forever for the current URL pattern. The extension needs permission to use localStorage for preserving these preferences. # Build