From ac54a960fc33565585a29135dc2791c70ea89cb9 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:21:42 +0100 Subject: [PATCH 01/17] update readme --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index eb7b1557..781435cf 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,27 @@ OpenPGP.js [![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png [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? +## 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](https://github.com/openpgpjs/openpgpjs/releases). -You can also build a current version yourself: - +### Build the library yourself npm install && grunt Then take `dist/openpgp.min.js` to use in your project. # 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). +## 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? You want to help, great! Go ahead and fork our repo, make your changes and make a pull request. From 786b0c2d3ef06802c633a029062e7c16383fb607 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:24:12 +0100 Subject: [PATCH 02/17] update readme --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 781435cf..ca4df317 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@ OpenPGP.js [![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png [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? +# Installation ## Node npm install openpgpjs ## Browser -The library has AMD support but can also be accessed via window.openpgp +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). @@ -18,10 +18,13 @@ You can download a prebuilt minified version of the library under [releases](htt Then take `dist/openpgp.min.js` to use in your project. -# I need some help +#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](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/). From 1eaf875696b2a62e6c286ff06bbd94432b5a0466 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:26:03 +0100 Subject: [PATCH 03/17] bump version to v0.2.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d983afa1..850e6e40 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "openpgp", - "version": "0.2.0-dev", + "version": "0.2.0", "engines": { "node": ">=0.8" }, From d6a7f6a6ef117737906ccbb813ee9a93b9ee9157 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:38:31 +0100 Subject: [PATCH 04/17] update package.json --- package.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 850e6e40..d3d330bd 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,13 @@ { - "name": "openpgp", + "name": "openpgpjs", "version": "0.2.0", "engines": { "node": ">=0.8" }, + "author": { + "name": "The OpenPGP.js Project", + "url": "http://openpgpjs.org/" + }, "main": "src/index.js", "directories": { "lib": "src" From 1f92088508485cb0f80dd2112215f8e4f23e767f Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:45:03 +0100 Subject: [PATCH 05/17] move travis badge --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca4df317..b8b1e72c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -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). +[![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png?branch=master,v0.1.x)](http://travis-ci.org/openpgpjs/openpgpjs) + # Installation ## Node npm install openpgpjs From 22ee7f1601fa9f759cbeec79e16551d3d718273d Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:50:34 +0100 Subject: [PATCH 06/17] readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8b1e72c..06eeb3aa 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ OpenPGP.js [![Build Status](https://secure.travis-ci.org/openpgpjs/openpgpjs.png?branch=master,v0.1.x)](http://travis-ci.org/openpgpjs/openpgpjs) # Installation -## Node +## Node.js npm install openpgpjs ## Browser From 9ed30ee09dcf82702d5f7b2b5ce4ba653b7b2f25 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:53:23 +0100 Subject: [PATCH 07/17] cleanup for npm --- README.md | 4 +--- package.json | 1 + 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 06eeb3aa..1e541165 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -OpenPGP.js +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](http://openpgpjs.org/) is a Javascript implementation of the OpenPGP protocol. This is defined in [RFC 4880](http://tools.ietf.org/html/rfc4880). -[![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 diff --git a/package.json b/package.json index d3d330bd..37e5ac03 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,6 @@ { "name": "openpgpjs", + "description": "A Javascript implementation of the OpenPGP protocol.", "version": "0.2.0", "engines": { "node": ">=0.8" From cde708f3470aa44e401a9bad4e4dab66f9cb1830 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:58:46 +0100 Subject: [PATCH 08/17] update description to make finding easier via npm --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 37e5ac03..61e908ac 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "openpgpjs", - "description": "A Javascript implementation of the OpenPGP protocol.", + "description": "A Javascript implementation of the OpenPGP/GPG/PGP protocol.", "version": "0.2.0", "engines": { "node": ">=0.8" From 9e692cf9155531dbf156196d653fa6c3fe6eba0e Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 19:59:36 +0100 Subject: [PATCH 09/17] move travis badge --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e541165..06eeb3aa 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -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). +[![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 From d0b916fc3cb44ce2bdd972b891712adbe8948f51 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 20:00:52 +0100 Subject: [PATCH 10/17] update description to make finding easier via npm --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 61e908ac..f42b608f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "openpgpjs", - "description": "A Javascript implementation of the OpenPGP/GPG/PGP protocol.", + "description": "A Javascript implementation of the OpenPGP/GPG protocol.", "version": "0.2.0", "engines": { "node": ">=0.8" From bf46ff3c9dea30e8fcf84d88ed756f2db62f123b Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 20:46:31 +0100 Subject: [PATCH 11/17] fix tests --- Gruntfile.js | 2 +- README.md | 3 ++- test/crypto/cipher/aes.js | 2 +- test/crypto/cipher/blowfish.js | 2 +- test/crypto/cipher/cast5.js | 2 +- test/crypto/cipher/des.js | 2 +- test/crypto/cipher/twofish.js | 2 +- test/crypto/crypto.js | 2 +- test/crypto/hash/md5.js | 2 +- test/crypto/hash/ripemd.js | 2 +- test/crypto/hash/sha.js | 2 +- test/general/basic.js | 2 +- test/general/key.js | 2 +- test/general/keyring.js | 2 +- test/general/packet.js | 2 +- test/general/signature.js | 2 +- 16 files changed, 17 insertions(+), 16 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index 7df5a5e8..73541387 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -153,5 +153,5 @@ module.exports = function(grunt) { }); // Test/Dev tasks - grunt.registerTask('test', ['copy', 'mocha_phantomjs', 'mochaTest']); + grunt.registerTask('test', ['copy', 'mochaTest', 'mocha_phantomjs']); }; diff --git a/README.md b/README.md index 06eeb3aa..7e2ae438 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ You can download a prebuilt minified version of the library under [releases](htt 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/'. +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: + npm install && npm test ## 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). diff --git a/test/crypto/cipher/aes.js b/test/crypto/cipher/aes.js index ce1ccade..2befa313 100644 --- a/test/crypto/cipher/aes.js +++ b/test/crypto/cipher/aes.js @@ -1,6 +1,6 @@ '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, chai = require('chai'), diff --git a/test/crypto/cipher/blowfish.js b/test/crypto/cipher/blowfish.js index 81100dd7..2600a06b 100644 --- a/test/crypto/cipher/blowfish.js +++ b/test/crypto/cipher/blowfish.js @@ -1,6 +1,6 @@ '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, BFencrypt = openpgp.crypto.cipher.blowfish, diff --git a/test/crypto/cipher/cast5.js b/test/crypto/cipher/cast5.js index 40ab972e..6a222fde 100644 --- a/test/crypto/cipher/cast5.js +++ b/test/crypto/cipher/cast5.js @@ -1,6 +1,6 @@ '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, chai = require('chai'), diff --git a/test/crypto/cipher/des.js b/test/crypto/cipher/des.js index 958b2a78..1b2c49ef 100644 --- a/test/crypto/cipher/des.js +++ b/test/crypto/cipher/des.js @@ -1,6 +1,6 @@ '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, chai = require('chai'), diff --git a/test/crypto/cipher/twofish.js b/test/crypto/cipher/twofish.js index e2ee828c..0ad46dde 100644 --- a/test/crypto/cipher/twofish.js +++ b/test/crypto/cipher/twofish.js @@ -1,6 +1,6 @@ '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, chai = require('chai'), diff --git a/test/crypto/crypto.js b/test/crypto/crypto.js index acd43981..bda39828 100644 --- a/test/crypto/crypto.js +++ b/test/crypto/crypto.js @@ -1,6 +1,6 @@ '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'), expect = chai.expect; diff --git a/test/crypto/hash/md5.js b/test/crypto/hash/md5.js index b3d0a777..fb431b0a 100644 --- a/test/crypto/hash/md5.js +++ b/test/crypto/hash/md5.js @@ -1,6 +1,6 @@ '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, MD5 = openpgp.crypto.hash.md5, diff --git a/test/crypto/hash/ripemd.js b/test/crypto/hash/ripemd.js index 75c353c9..df153e04 100644 --- a/test/crypto/hash/ripemd.js +++ b/test/crypto/hash/ripemd.js @@ -1,6 +1,6 @@ '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, RMDstring = openpgp.crypto.hash.ripemd, diff --git a/test/crypto/hash/sha.js b/test/crypto/hash/sha.js index ce8da58a..cd4166d0 100644 --- a/test/crypto/hash/sha.js +++ b/test/crypto/hash/sha.js @@ -1,6 +1,6 @@ '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, hash = openpgp.crypto.hash, diff --git a/test/general/basic.js b/test/general/basic.js index f712ec2e..a4d81eae 100644 --- a/test/general/basic.js +++ b/test/general/basic.js @@ -1,6 +1,6 @@ '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'), expect = chai.expect; diff --git a/test/general/key.js b/test/general/key.js index ccaa40ca..75657025 100644 --- a/test/general/key.js +++ b/test/general/key.js @@ -1,6 +1,6 @@ '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'), expect = chai.expect; diff --git a/test/general/keyring.js b/test/general/keyring.js index d4003d5b..0d7829cf 100644 --- a/test/general/keyring.js +++ b/test/general/keyring.js @@ -1,6 +1,6 @@ '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(), chai = require('chai'), diff --git a/test/general/packet.js b/test/general/packet.js index ecac10ff..a2f4d74e 100644 --- a/test/general/packet.js +++ b/test/general/packet.js @@ -1,6 +1,6 @@ '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'), expect = chai.expect; diff --git a/test/general/signature.js b/test/general/signature.js index f276d64f..c2e2953b 100644 --- a/test/general/signature.js +++ b/test/general/signature.js @@ -1,6 +1,6 @@ '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'), expect = chai.expect; From 4b24ff9983e9c5cd7c85ff537eaeda5f0ca8fd2e Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 21:01:48 +0100 Subject: [PATCH 12/17] test against node 0.8 and 0.10 in travis --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index f5632394..7d9f4a9f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,6 @@ language: node_js node_js: - "0.10" + - "0.8" before_install: - npm install -g grunt-cli \ No newline at end of file From f3988e41157e34da34c528042c772e09a8d73a16 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 21:26:35 +0100 Subject: [PATCH 13/17] fix package.json --- package.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index f42b608f..f7152c67 100644 --- a/package.json +++ b/package.json @@ -5,10 +5,8 @@ "engines": { "node": ">=0.8" }, - "author": { - "name": "The OpenPGP.js Project", - "url": "http://openpgpjs.org/" - }, + "homepage": "http://openpgpjs.org/", + "keywords": ["crypto", "pgp", "gpg", "openpgp"], "main": "src/index.js", "directories": { "lib": "src" From fcbfb28c280681ca20263cd6b1737d9a09034c1e Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 21:32:20 +0100 Subject: [PATCH 14/17] update description --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f7152c67..1a9b3d72 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "openpgpjs", - "description": "A Javascript implementation of the OpenPGP/GPG protocol.", + "description": "A Javascript implementation of the OpenPGP protocol.", "version": "0.2.0", "engines": { "node": ">=0.8" From e4c8bda43e36fcdb4c8c03bd61e7a8aad1b2af86 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 21:38:15 +0100 Subject: [PATCH 15/17] remove slash from homepage --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 1a9b3d72..f785ae56 100644 --- a/package.json +++ b/package.json @@ -2,10 +2,10 @@ "name": "openpgpjs", "description": "A Javascript implementation of the OpenPGP protocol.", "version": "0.2.0", + "homepage": "http://openpgpjs.org", "engines": { "node": ">=0.8" }, - "homepage": "http://openpgpjs.org/", "keywords": ["crypto", "pgp", "gpg", "openpgp"], "main": "src/index.js", "directories": { From 9e1269c5cd7efb50b7544519c112fe2a35837003 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 21:38:57 +0100 Subject: [PATCH 16/17] use https in git repo --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f785ae56..985881f3 100644 --- a/package.json +++ b/package.json @@ -40,6 +40,6 @@ }, "repository": { "type": "git", - "url": "http://github.com/openpgpjs/openpgpjs" + "url": "https://github.com/openpgpjs/openpgpjs" } } From 6fa31396c09bffe778e807f8265209d289f1e4bf Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Fri, 10 Jan 2014 21:40:56 +0100 Subject: [PATCH 17/17] fix homepage --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 985881f3..52bf99a2 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "openpgpjs", "description": "A Javascript implementation of the OpenPGP protocol.", "version": "0.2.0", - "homepage": "http://openpgpjs.org", + "homepage": "http://openpgpjs.org/", "engines": { "node": ">=0.8" },