From bcde9bfa1ab5805d568ae505e3d3445a5718d638 Mon Sep 17 00:00:00 2001 From: Tankred Hase Date: Sat, 12 Dec 2015 10:39:38 +0700 Subject: [PATCH] Add HKP lookup example to README --- README.md | 12 ++++++++++++ src/hkp/hkp.js | 4 ++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 120beee7..72374d15 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,18 @@ openpgp.generateKeyPair(options).then(function(keypair) { }); ``` +#### Public key lookup on HKP server +```js +var openpgp = require('openpgp'); +var hkp = new openpgp.HKP('https://pgp.mit.edu'); + +hkp.lookup({ + query: 'alice@example.com' +}).then(function(key) { + var publicKey = openpgp.key.readArmored(key); +}); +``` + #### Encryption ```js var openpgp = require('openpgp'); diff --git a/src/hkp/hkp.js b/src/hkp/hkp.js index 384b3f96..92e03732 100644 --- a/src/hkp/hkp.js +++ b/src/hkp/hkp.js @@ -44,8 +44,8 @@ function HKP(keyServerBaseUrl, fetch) { /** * Search for a public key on the key server either by key ID or part of the user ID. * @param {String} options.keyID The long public key ID. - * @param {String} options.query This can be any part of the key user ID such as name. - * or email address + * @param {String} options.query This can be any part of the key user ID such as name + * or email address. * @return {Promise} The ascii armored public key. */ HKP.prototype.lookup = function(options) {