Merge branch 'master' into example

This commit is contained in:
Robert Nelson 2014-01-10 13:39:35 -08:00
commit e73d868cdb
18 changed files with 41 additions and 25 deletions

View File

@ -1,5 +1,6 @@
language: node_js language: node_js
node_js: node_js:
- "0.10" - "0.10"
- "0.8"
before_install: before_install:
- npm install -g grunt-cli - npm install -g grunt-cli

View File

@ -153,5 +153,5 @@ module.exports = function(grunt) {
}); });
// Test/Dev tasks // Test/Dev tasks
grunt.registerTask('test', ['copy', 'mocha_phantomjs', 'mochaTest']); grunt.registerTask('test', ['copy', 'mochaTest', 'mocha_phantomjs']);
}; };

View File

@ -1,24 +1,36 @@
OpenPGP.js [![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png?branch=master,v0.1.x)](http://travis-ci.org/openpgpjs/openpgpjs) 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). [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? [![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png?branch=master,v0.1.x)](http://travis-ci.org/openpgpjs/openpgpjs)
# Installation
## Node.js
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](https://github.com/openpgpjs/openpgpjs/releases). You can download a prebuilt minified version of the library under [releases](https://github.com/openpgpjs/openpgpjs/releases).
You can also build a current version yourself: ### Build the library yourself
npm install && grunt npm install && grunt
Then take `dist/openpgp.min.js` to use in your project. Then take `dist/openpgp.min.js` to use in your project.
# I need some help #Usage
## Mailing List It's best the check the documentation for detailed API information. There are also alot of useful examples under 'test/'. You can run the tests by calling:
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/). npm install && npm test
## Documentation ## 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). 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).
# 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/).
# How do I get involved? # How do I get involved?
You want to help, great! Go ahead and fork our repo, make your changes You want to help, great! Go ahead and fork our repo, make your changes
and make a pull request. and make a pull request.

View File

@ -1,9 +1,12 @@
{ {
"name": "openpgp", "name": "openpgpjs",
"version": "0.2.0-dev", "description": "A Javascript implementation of the OpenPGP protocol.",
"version": "0.2.0",
"homepage": "http://openpgpjs.org/",
"engines": { "engines": {
"node": ">=0.8" "node": ">=0.8"
}, },
"keywords": ["crypto", "pgp", "gpg", "openpgp"],
"main": "src/index.js", "main": "src/index.js",
"directories": { "directories": {
"lib": "src" "lib": "src"
@ -37,6 +40,6 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "http://github.com/openpgpjs/openpgpjs" "url": "https://github.com/openpgpjs/openpgpjs"
} }
} }

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
chai = require('chai'), chai = require('chai'),

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
BFencrypt = openpgp.crypto.cipher.blowfish, BFencrypt = openpgp.crypto.cipher.blowfish,

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
chai = require('chai'), chai = require('chai'),

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
chai = require('chai'), chai = require('chai'),

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
chai = require('chai'), chai = require('chai'),

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../src/index');
var chai = require('chai'), var chai = require('chai'),
expect = chai.expect; expect = chai.expect;

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
MD5 = openpgp.crypto.hash.md5, MD5 = openpgp.crypto.hash.md5,

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
RMDstring = openpgp.crypto.hash.ripemd, RMDstring = openpgp.crypto.hash.ripemd,

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../../src/index');
var util = openpgp.util, var util = openpgp.util,
hash = openpgp.crypto.hash, hash = openpgp.crypto.hash,

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../src/index');
var chai = require('chai'), var chai = require('chai'),
expect = chai.expect; expect = chai.expect;

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../src/index');
var chai = require('chai'), var chai = require('chai'),
expect = chai.expect; expect = chai.expect;

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../src/index');
var keyring = new openpgp.Keyring(), var keyring = new openpgp.Keyring(),
chai = require('chai'), chai = require('chai'),

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../src/index');
var chai = require('chai'), var chai = require('chai'),
expect = chai.expect; expect = chai.expect;

View File

@ -1,6 +1,6 @@
'use strict'; 'use strict';
var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('openpgp'); var openpgp = typeof window != 'undefined' && window.openpgp ? window.openpgp : require('../../src/index');
var chai = require('chai'), var chai = require('chai'),
expect = chai.expect; expect = chai.expect;