You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Keith Grant 2c39569af2
Merge pull request #91 from vhfmag/implement-sidebar-action
1 year ago
.github/ISSUE_TEMPLATE Update issue templates 2 years ago
dist Implement sidebar action and make css responsive 1 year ago
icons add indicator when site supports webmention 2 years ago
src Implement sidebar action and make css responsive 1 year ago
static Implement sidebar action and make css responsive 1 year ago
.babelrc move authentication into store 2 years ago
.eslintrc.js de-lint; style cleanup 2 years ago
.gitattributes Ignore zips/ directory in archive files 3 years ago
.gitignore gitignore sourcemaps - fixes #24 3 years ago
LICENSE Create LICENSE 3 years ago
NOTES.md embed fonts; remember draft type 2 years ago
README.md get reacji working again; restyle reacji 2 years ago
package-lock.json fix package-lock 2 years ago
package.json fix package-lock 2 years ago
webpack.common.js move authentication into store 2 years ago
webpack.dev.js update to webpack 4 2 years ago
webpack.prod.js update to webpack 4 2 years ago
webpack.test.js update testing tools to latest versions 2 years ago

README.md

Omnibear

For general usage information, see https://omnibear.com.

Development

After cloning the repository, run npm install to install dependencies.

  • npm run build: build into the /dist directory.
  • npm start: build and automatically watch for changes and rebuild.
  • npm test: run tests. npm test -- --watch will watch for changes and re-run tests every time. If you have issues, make sure you are using node 8.x (the LTS version).

Installing from the repository

To install in Chrome from the repository:

  1. Navigate to chrome://extensions/
  2. Check the “Developer mode” box
  3. Click “Load unpacked extension” and select the /dist directory of the repository

To install in Firefox from the repository:

  1. Navigate to about:debugging
  2. Click “Load Temporary Add-On”
  3. Navigate to the /dist directory and select the manifest.json file

Theoretically, this should work in MS Edge, too, but I don’t run Windows so I haven’t tested that out.

Overview

Omnibear is run by three scripts:

  • src/background.js — Runs in a background page. This keeps track of which tab currently has the user’s focus and handles communication between the page script and omnibear popup script.
  • src/page.js — A content script that runs in all pages (tabs). This highlights selected entries when the user right-clicks them. It alerts the background script whenever its tab receives user focus. And it watches for when the browser navigates to the authentication successful page on omnibear.com.
  • src/index.js — The main script of the popup page. This is a small webapp built using Preact and MobX that includes the posting form and settings screen.

Authentication details, user settings, and the note draft are stored in Omnibear’s localStorage.