From 3cf3d432e5e12dc3404edeaf11cc2002dca49078 Mon Sep 17 00:00:00 2001 From: semanticdata Date: Fri, 10 May 2024 20:45:03 -0500 Subject: [PATCH] new README in place --- README-fresh.md | 24 ------------------------ README-old.md | 42 ++++++++++++++++++++++++++++++++++++++++++ README.md | 33 ++------------------------------- 3 files changed, 44 insertions(+), 55 deletions(-) delete mode 100644 README-fresh.md create mode 100644 README-old.md diff --git a/README-fresh.md b/README-fresh.md deleted file mode 100644 index a650c97..0000000 --- a/README-fresh.md +++ /dev/null @@ -1,24 +0,0 @@ -# 🔌 Browser Extensions - -> ⚠ Note: this is a work-in-progress. - -This monorepo[^1] contains the source code for my browser extensions. Its aim is to make maintenance easier. - -![banner](assets/banners/brave-header-2.png) ![banner](assets/banners/chatgpt-banner-1.png) ![banner](assets/banners/discord-banner-2.png) ![banner](assets/banners/fastmail-sidebar-1.png) ![banner](assets/banners/gemini-2.png) ![banner](assets/banners/hn-2.png) ![banner](assets/banners/llamalife-2.png) ![banner](assets/banners/metaai-2.png) ![banner](assets/banners/newtab-bookmarks-1.png) ![banner](assets/banners/notekeeper-2.png) ![banner](assets/banners/sorry-mn-only-2.png) ![banner](assets/banners/telegram-sidebar-1.png) ![banner](assets/banners/ticktick-pinned-2.png) ![banner](assets/banners/ticktick-sidebar-1.png) ![banner](assets/banners/whatsapp-pinned-1.png) ![banner](assets/banners/whatsapp-sidebar-2.png) - - - -## ☑ Requirements - -Two repository secrets are required to sign extensions prior releasing a new version with [web-ext](https://github.com/mozilla/web-ext). - -- JWT Issuer: `FIREFOX_JWT_ISSUER` -- JWT Secret: `FIREFOX_JWT_SECRET` - -Visit the [Manage API Keys](https://addons.mozilla.org/en-US/developers/addon/api/key/) page to obtain yours. - -## © License - -Source code in this repository is available under the [MIT License](LICENSE). - -[^1]: In version-control systems, a monorepo ("mono" meaning 'single' and "repo" being short for 'repository') is a software-development strategy in which the code for a number of projects is stored in the same repository. diff --git a/README-old.md b/README-old.md new file mode 100644 index 0000000..c2a083e --- /dev/null +++ b/README-old.md @@ -0,0 +1,42 @@ +# 🔌 Browser Extensions + +> ⚠ Note: this is a work-in-progress. + +This monorepo[^1] contains the source code for my browser extensions. Its aim is to make maintenance easier. + +## 📦 Contents + +| | Description | | +| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------: | +| | [Brave Search](/brave-search/) Adds Brave Search as a search engine option within Firefox. Also includes keyword @brave as a search shortcut. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [ChatGPT in Sidebar](/chatgpt-in-sidebar/) | Opens ChatGPT within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Discord in Sidebar](/discord-in-sidebar/) | Display Discord within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Fastmail in Sidebar](/fastmail-in-sidebar/) | Display Fastmail within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Gemini in Sidebar](/gemini-in-sidebar/) | Display Gemini within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Hacker News in Sidebar](/hacker-news-in-sidebar/) | Display Hacker News within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Llama Life in Sidebar](/llamalife-in-sidebar/) | Display Llama Life within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Meta AI in Sidebar](/metaai-in-sidebar/) | Display Meta AI within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [New Tab Bookmarks](/new-tab-bookmarks/) | A new tab replacement for your browser. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Notekeeper](/notekeeper/) | An extension that transforms the New Tab into a minimalist, auto-saving text editor. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Sorry, Minnesota Only](/sorry-minnesota-only/) | | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [Telegram in Sidebar](/telegram-in-sidebar/) | Display Telegram within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [TickTick in Sidebar](/telegram-in-sidebar/) | Display TickTick within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [TickTick Pinned](/ticktick-pinned/) | Opens TickTick in a pinned tab. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [WhatsApp in Sidebar](/whatsapp-in-sidebar/) | Display WhatsApp within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| [WhatsApp Pinned](/whatsapp-pinned/) | Opens WhatsApp in a pinned tab. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | +| | Reveal deeper information about text you highlight on a web page. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | + +## ☑ Requirements + +Two repository secrets are required to sign extensions prior releasing a new version with [web-ext](https://github.com/mozilla/web-ext). + +- JWT Issuer: `FIREFOX_JWT_ISSUER` +- JWT Secret: `FIREFOX_JWT_SECRET` + +Visit the [Manage API Keys](https://addons.mozilla.org/en-US/developers/addon/api/key/) page to obtain yours. + +## © License + +Source code in this repository is available under the [MIT License](LICENSE). + +[^1]: In version-control systems, a monorepo ("mono" meaning 'single' and "repo" being short for 'repository') is a software-development strategy in which the code for a number of projects is stored in the same repository. diff --git a/README.md b/README.md index c2a083e..9fe52da 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,9 @@ > ⚠ Note: this is a work-in-progress. -This monorepo[^1] contains the source code for my browser extensions. Its aim is to make maintenance easier. +This monorepo[^1] contains the source code for my browser extensions. It aims to make maintenance easier. -## 📦 Contents - -| | Description | | -| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------: | -| | [Brave Search](/brave-search/) Adds Brave Search as a search engine option within Firefox. Also includes keyword @brave as a search shortcut. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [ChatGPT in Sidebar](/chatgpt-in-sidebar/) | Opens ChatGPT within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Discord in Sidebar](/discord-in-sidebar/) | Display Discord within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Fastmail in Sidebar](/fastmail-in-sidebar/) | Display Fastmail within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Gemini in Sidebar](/gemini-in-sidebar/) | Display Gemini within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Hacker News in Sidebar](/hacker-news-in-sidebar/) | Display Hacker News within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Llama Life in Sidebar](/llamalife-in-sidebar/) | Display Llama Life within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Meta AI in Sidebar](/metaai-in-sidebar/) | Display Meta AI within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [New Tab Bookmarks](/new-tab-bookmarks/) | A new tab replacement for your browser. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Notekeeper](/notekeeper/) | An extension that transforms the New Tab into a minimalist, auto-saving text editor. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Sorry, Minnesota Only](/sorry-minnesota-only/) | | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [Telegram in Sidebar](/telegram-in-sidebar/) | Display Telegram within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [TickTick in Sidebar](/telegram-in-sidebar/) | Display TickTick within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [TickTick Pinned](/ticktick-pinned/) | Opens TickTick in a pinned tab. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [WhatsApp in Sidebar](/whatsapp-in-sidebar/) | Display WhatsApp within the Firefox sidebar. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| [WhatsApp Pinned](/whatsapp-pinned/) | Opens WhatsApp in a pinned tab. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | -| | Reveal deeper information about text you highlight on a web page. | [![get the addon](get-addon-firefox.png)](https://addons.mozilla.org/en-US/firefox/addon/brave-search-and-keyword/) | - -## ☑ Requirements - -Two repository secrets are required to sign extensions prior releasing a new version with [web-ext](https://github.com/mozilla/web-ext). - -- JWT Issuer: `FIREFOX_JWT_ISSUER` -- JWT Secret: `FIREFOX_JWT_SECRET` - -Visit the [Manage API Keys](https://addons.mozilla.org/en-US/developers/addon/api/key/) page to obtain yours. +![banner](assets/banners/brave-header-2.png) ![banner](assets/banners/chatgpt-banner-1.png) ![banner](assets/banners/discord-banner-2.png) ![banner](assets/banners/fastmail-sidebar-1.png) ![banner](assets/banners/gemini-2.png) ![banner](assets/banners/hn-2.png) ![banner](assets/banners/llamalife-2.png) ![banner](assets/banners/metaai-2.png) ![banner](assets/banners/newtab-bookmarks-1.png) ![banner](assets/banners/notekeeper-2.png) ![banner](assets/banners/sorry-mn-only-2.png) ![banner](assets/banners/telegram-sidebar-1.png) ![banner](assets/banners/ticktick-pinned-2.png) ![banner](assets/banners/ticktick-sidebar-1.png) ![banner](assets/banners/whatsapp-pinned-1.png) ![banner](assets/banners/whatsapp-sidebar-2.png) ## © License