Git Product home page Git Product logo

browser-extension's Introduction

Hypothesis browser extension(s)

Build status #hypothes.is IRC channel BSD licensed

The Hypothesis browser extensions allow you to annotate web documents using your Hypothesis account.

Screenshot of Hypothesis client

Choose your browser below

Chrome Firefox Opera Safari IE
Chrome Firefox Opera Safari IE
Now available In development not yet not yet not yet

Development

The code for the extensions is in the src/ directory, and can be built into a browser extension by running:

npm install
make

Once this is done you should be able to load the build/ directory as an unpacked extension.

The extension code has a test suite, which you can run using:

npm test

Note that the browser extensions are for the most part just a wrapper around the Hypothesis client. Depending on what you're interested in working on, you may need to check out the client repository too. If you do that, you can get the browser extension repository to use your checked-out client repository by running

npm link

in the client repository, and then

npm link hypothesis

in the browser-extension repository. After that, a call to make will use the built client from the client repository. Please consult the client's documentation for instructions on building the client in a development environment.

Tip: If you get a permission denied error when running npm link you probably need to fix npm's permissions. See Fixing npm permissions.

Tip: To unlink your dev browser extension from your dev client run npm unlink hypothesis in your browser extension directory (see the npm uninstall docs).

See Building the extension for more information.

Community

Join us in #hypothes.is on freenode for discussion.

If you'd like to contribute to the project, you should consider subscribing to the development mailing list, where we can help you plan your contributions.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

The Hypothesis browser extensions are released under the 2-Clause BSD License, sometimes referred to as the "Simplified BSD License". Some third-party components are included. They are subject to their own licenses. All of the license information can be found in the included LICENSE file.

browser-extension's People

Contributors

aron avatar bigbluehat avatar chdorner avatar csillag avatar jtremback avatar nickstenning avatar robertknight avatar sean-roberts avatar seanh avatar tilgovi avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.