beagle
Navigating the sea of publications
##Installation
- Git clone this repository.
- In order to enable this in chrome, you need to open Chrome Settings > Extensions. Click 'Load Unpacked Extension'. Select the
buildfolder from within this repository. - Go to any page, and click on the icon in the search bar. To see best results, click the icon while looking at a pdf. For best results, open a PDF in Chrome and inject the sidebar into it.
Developer Installation
You will need to install node. This will come with npm preinstalled. Once you have cloned the folder, following the first step above, run npm install.
When you have edited main.js or any dependency of it, run: $ gulp. You may need to run npm install browserify -g first. This will set up a watcher on the code - when you make changes, it will reflect those changes in build. If you need to watch background.js instead, run gulp --path background. This will ensure that everything is compiled into bundle.js. After it states default done, force refresh (command+shift+r) the page your .pdf loaded on before clicking the Beagle icon.
When you are working on the extension with the intention of using the content script - this happens whenever you are injecting the sidebar into an html page and not using the PDF.js interface - you need to refresh the extensions page as well as the page your extension is injected into.
Style
We use feross's standard. Please use a hinter or linter which adheres to it - if you need help, ask @RichardLitt.
When in doubt, plunk it into a new module.