Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# 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.

## 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
Expand Down
17 changes: 14 additions & 3 deletions extension/content.js
Original file line number Diff line number Diff line change
Expand Up @@ -305,15 +305,26 @@ function showWelcomeInfo(request) {

text = div('sax-welcome-text');
text.innerHTML = `<p id="sax-welcome-text-title">
The cat found something curious!
How do I use Curiously?
</p>
</br>
<p id="sax-welcome-text-body">
You will find all sorts of hidden gems on the internet.
Simple! You can change links two ways.
</br>
Engage your curiousity by clicking on the "C" icon in the toolbar, or press <span id="sax-keyboard-shortcut">${os === 'mac' ? "Alt+Shift+S" : "Alt+Shift+S"}
1.) Click on the Curiously logo in the extension bar.
</br>
2.) Use the hotkey <span id="sax-keyboard-shortcut">${os === 'mac' ? "Alt+Shift+S" : "Alt+Shift+S"}
</span>
</br></br>
<p id="sax-welcome-text-title">
How do I stay in a category?
</p>
</br>
<p id="sax-welcome-text-body">
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.
</p>
</br>
<div id="sax-welcome-new-feature">
<img id="sax-rabbit-hole-spiral-2" src=${chrome.extension.getURL('images/spiral.png')} />
<span id='sax-welcome-text-body-small-accent'>Did You Know?</span>
Expand Down