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/
116 Commits 1 Branch 0 Tags 39 MiB
JavaScript 99.1%
TypeScript 0.8%
1400918613
Go to file
seancolyer 1400918613 Updating README
2013-03-25 21:57:46 -04:00
Dependencies added sjcl as dependency 2012-01-17 11:32:24 +01:00
doc Updates to documentation. Most all classes should now be jsdoc compliant. 2012-09-11 21:54:42 -04:00
plugins/chrome Chrome plugin import cleanup. 2012-06-25 20:48:46 -04:00
resources Fix bug with key material expecting s2k.type to exist which breaks with 2013-03-06 20:36:26 -05:00
scripts Fix bug with key material expecting s2k.type to exist which breaks with 2013-03-06 20:36:26 -05:00
src Fix bug with key material expecting s2k.type to exist which breaks with 2013-03-06 20:36:26 -05:00
test openpgp_keyring include subkeys by ID 2013-02-13 22:31:27 -08:00
webmail/googlemail.com - removing executable flag from files 2011-12-09 18:29:47 +01:00
.gitattributes Merge branch 'refactor'. Also marking resources/openpgp*.js files as 2013-01-14 20:44:58 -05:00
.gitignore added os x file 2012-01-16 02:05:16 +01:00
.gitmodules added sjcl as dependency 2012-01-17 11:32:24 +01:00
LICENSE adding restructured GPG4Browsers code 2011-12-09 18:25:41 +01:00
Makefile renamed file 2012-01-18 11:07:00 +01:00
README Updating README 2013-03-25 21:57:46 -04:00

README 

# What is OpenPGP.js?
[OpenPGP.js](http://openpgpjs.org/) is a Javascript implementation of the OpenPGP protocol. This is defined in [RFC 4880](http://tools.ietf.org/html/rfc4880).

# How do I use it?
As a developer, the best place to start is in the `resources/` directory. Within this you will find a basic example implementation and the "binary" files for this library. It is likely that you will want to use `resources/openpgp.min.js` on your site, this is a minified version of our library.

# I need some help
## Mailing List
You can [sign up](http://list.openpgpjs.org/) for our mailing list and ask for help there.  We've recently worked on getting our [archive up and running](http://www.mail-archive.com/list@openpgpjs.org/).

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

# How do I get involved?
You want to help, great! Go ahead and fork our repo, make your changes and make a pull request. Please be sure that you run `make minify` from the root directory to concatenate and minify the library into the `resources/` directory.

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](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.

* [http://www.hanewin.net/encrypt/](http://www.hanewin.net/encrypt/)
* [https://github.com/seancolyer/gmail-crypt](https://github.com/seancolyer/gmail-crypt)
* [https://github.com/mete0r/openpgp-js](https://github.com/mete0r/openpgp-js)
* [http://fitblip.github.com/JSPGP-Stuffs/](http://fitblip.github.com/JSPGP-Stuffs/)
* [http://qooxdoo.org/contrib/project/crypto](http://qooxdoo.org/contrib/project/crypto)
* [https://github.com/GPGTools/Mobile/wiki/Introduction](https://github.com/GPGTools/Mobile/wiki/Introduction)
* [http://gpg4browsers.recurity.com/](http://gpg4browsers.recurity.com/)