Go to file

Jeremy Dormitzer 1f02f207d9 Update documentation to explain Figwheel support		2018-02-16 12:05:02 -05:00
doc	Initial commit	2018-01-06 21:38:01 -05:00
resources	Enable Figwheel for background and sidebar scripts in dev build	2018-02-16 11:56:54 -05:00
src	Remove unecessary user id generation code	2018-02-07 09:12:22 -05:00
.gitignore	Enable Figwheel for background and sidebar scripts in dev build	2018-02-16 11:56:54 -05:00
CHANGELOG.md	Update documentation to explain Figwheel support	2018-02-16 12:05:02 -05:00
LICENSE	Write README and update licensing	2018-02-04 10:00:21 -05:00
Makefile	Clean by default before building dev or prod	2018-02-16 12:04:23 -05:00
project.clj	Enable Figwheel for background and sidebar scripts in dev build	2018-02-16 11:56:54 -05:00
README.md	Update documentation to explain Figwheel support	2018-02-16 12:05:02 -05:00

README.md

Looped In

A browser extension that displays Hacker News comments for the current webpage

Looped In is a browser extension that displays Hacker News comments for the current webpage in a sidebar. It is written in ClojureScript.

Looped In will be available from the Firefox Add-ons site and the Chrome Web Store pending review. If you'd prefer to clone the repository and run the extension locally, read on.

Usage

To build Looped In locally, you'll need Leiningen and GNU Make.

To obtain a copy of the source code:

$ git clone git@github.com:jdormit/looped-in.git

To build the source code, navigate to the project root and run:

$ make dev

This will output a development build of the extension to ext. Additionally, it will start a Figwheel session for the background and sidebar scripts, enabling live reloading and connecting a Clojurescript REPL to the sidebar script. Due to strict content security policy for content scripts, Figwheel cannot be enabled for the content script.

If you want a production build instead, run:

$ make prod

This will output an optimized production build of the extension to ext. The production build does not feature live reloading. It also takes significantly longer than the development build.

To load the extension locally in your browser, see instructions for Firefox or instructions for Chrome.

To package the extension for publication, run:

$ make package

This will package a production build of the extension to dist/looped-in.zip.

License

Distributed under the GNU General Public License v3. See LICENSE.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.