suzanne.soy/fork-openpgpjs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Fork of https://github.com/openpgpjs/openpgpjs from https://openpgpjs.org/
338 Commits 1 Branch 0 Tags 39 MiB
JavaScript 99.1%
TypeScript 0.8%
1f92088508
Go to file
Tankred Hase 1f92088508 move travis badge
2014-01-10 19:45:03 +01:00
doc Use individual source files instead of browserify bundle in node 2014-01-10 09:44:47 -08:00
example Implement node.js support and cleanup source tree. 2014-01-09 02:29:30 -08:00
jsdoc.template Show full class names in nav 2014-01-05 14:25:45 -08:00
src Fix travis problem hopefully for real this time 2014-01-09 09:59:25 -08:00
test Make standalone the default and use openpgp.min.js in node package 2014-01-09 17:02:42 -08:00
.gitattributes Fix make bundle-test and keyring unit-tests 2013-12-09 16:57:44 +01:00
.gitignore add dist/ to gitignore 2014-01-09 14:04:07 +01:00
.travis.yml reactive travis.yml but do nothing in npm test until devel branch is ready for testing 2013-10-23 18:42:49 +02:00
Gruntfile.js Use individual source files instead of browserify bundle in node 2014-01-10 09:44:47 -08:00
LICENSE adding restructured GPG4Browsers code 2011-12-09 18:25:41 +01:00
package.json update package.json 2014-01-10 19:38:31 +01:00
README.md move travis badge 2014-01-10 19:45:03 +01:00

README.md

OpenPGP.js

OpenPGP.js is a Javascript implementation of the OpenPGP protocol. This is defined in RFC 4880.

Build Status

Installation

Node

npm install openpgpjs

Browser

The library has AMD support but can also be accessed via 'window.openpgp'.

Prebuilt minified release

You can download a prebuilt minified version of the library under releases.

Build the library yourself

npm install && grunt

Then take dist/openpgp.min.js to use in your project.

#Usage It's best the check the documentation for detailed API information. There are also alot of useful examples under 'test/'.

Documentation

A jsdoc build of our code comments is available at doc/index.html. Public calls should generally be made through the OpenPGP object doc/openpgp.html.

I need some help

Mailing List

You can sign up for our mailing list and ask for help there. We've recently worked on getting our archive up and running.

How do I get involved?

You want to help, great! Go ahead and fork our repo, make your changes and make a pull request.

It is extra awesome if you write tests for the code you change. Our test coverage is relatively weak, so if you can add cases that is great.

What License do you use?

GNU Lesser General Public License (2.1). Please take a look at the LICENSE file for more information.

What are the requirements to use it?

OpenPGP.js currently only fully supports Chrome. Firefox support should be coming soon with the advent of Firefox 23 with native javascript support for window.crypto.getRandomValues. If you can help us support more browsers and situations, please chip in!

Resources

Below is a collection of resources, many of these were projects that were in someway a precursor to the current OpenPGP.js project. If you'd like to add your link here, please do so in a pull request or email to the list.