Go to file

Jeremy Dormitzer c144fc17d5 Clean by default before building dev or prod		2018-02-16 12:04:23 -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	Document changes	2018-02-15 22:55:41 -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	Document changes	2018-02-15 22:55:41 -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 once, navigate to the project root and run:

$ make clean dev

This will output the development build of the compiled extension to ext. The development build produces source maps and is significantly faster to compile. If you want a production build, run make clean prod instead.

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/.