diff --git a/README.md b/README.md index 5c6c88f..dc32ec4 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Curiously -Curiously is a discovery engine and browser add-on dedicated to showcasing the best of the internet. +Curiously is a discovery engine and browser extension dedicated to showcasing the best of the internet. # Project Status This project is in development and currently in alpha. @@ -7,12 +7,29 @@ This project is in development and currently in alpha. ## Website [Curiously](https://curiously.cc) -## Setup - Firefox +# Setup + +## Supabase + +Implementing this repo requires instantiating a Supabase DB based on a particular schema and creating a series of stored procedures. If you need the scripts containing the schema and stored procedures, please feel free to contact me [here](curiouslyapp@gmail.com) + +## Environment + +Once you setup Supabase, you'll need to create an env.js file in the extension folder of this repo and input your public key and project URL using the format below. + +```js + const env = { + ENV_SUPABASE_CONNECT: "YOUR ANON/PUBLIC KEY", + ENV_SUPABASE_URL: "YOUR PROJECT URL HERE" + } +``` + +## Firefox 1. Go to: about:debugging#/runtime/this-firefox 2. Click: "Load Temporary Add-on", and open the manifest.json of Curiously 3. Curiously should appear in your browser toolbar -## Setup - Chrome +## Chrome 1. Go to: Chrome: chrome://extensions/ 2. Click "Load unpacked" and open the extension folder 3. Go to the bookmark toolbar and pin Curiously onto the toolbar diff --git a/extension/content.js b/extension/content.js index 732c39b..1d33e25 100755 --- a/extension/content.js +++ b/extension/content.js @@ -305,15 +305,26 @@ function showWelcomeInfo(request) { text = div('sax-welcome-text'); text.innerHTML = `

- The cat found something curious! + How do I use Curiously?


- You will find all sorts of hidden gems on the internet. + Simple! You can change links two ways.
- Engage your curiousity by clicking on the "C" icon in the toolbar, or press ${os === 'mac' ? "Alt+Shift+S" : "Alt+Shift+S"} + 1.) Click on the Curiously logo in the extension bar. +
+ 2.) Use the hotkey ${os === 'mac' ? "Alt+Shift+S" : "Alt+Shift+S"}

+

+ How do I stay in a category? +

+
+

+ When you change links, click on the disappearing Curiously GIF. This locks your category. + To exit, click on the logo next to the spinning spiral. +

+
Did You Know?