From 5ca180120822a46623d916c750a82edd4a8691cb Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Sun, 9 Nov 2014 09:51:07 +0100 Subject: [PATCH] readme: add syntax highlighting This PR adds syntax highlighting to the readme. Thanks! --- README.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index cf9df765..a5b7868d 100644 --- a/README.md +++ b/README.md @@ -33,30 +33,31 @@ OpenPGP.js uses ES6 promises which are available in [most modern browsers](http: ### Examples #### Encryption - - var openpgp = require('openpgp'); - var key = '-----BEGIN PGP PUBLIC KEY BLOCK ... END PGP PUBLIC KEY BLOCK-----'; - var publicKey = openpgp.key.readArmored(key); - openpgp.encryptMessage(publicKey.keys, 'Hello, World!').then(function(pgpMessage) { - // success - }).catch(function(error) { - // failure - }); +```js +var openpgp = require('openpgp'); +var key = '-----BEGIN PGP PUBLIC KEY BLOCK ... END PGP PUBLIC KEY BLOCK-----'; +var publicKey = openpgp.key.readArmored(key); +openpgp.encryptMessage(publicKey.keys, 'Hello, World!').then(function(pgpMessage) { + // success +}).catch(function(error) { + // failure +}); +``` #### Decryption - - var openpgp = require('openpgp'); - var key = '-----BEGIN PGP PRIVATE KEY BLOCK ... END PGP PRIVATE KEY BLOCK-----'; - var privateKey = openpgp.key.readArmored(key).keys[0]; - privateKey.decrypt('passphrase'); - var pgpMessage = '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'; - pgpMessage = openpgp.message.readArmored(pgpMessage); - openpgp.decryptMessage(privateKey, pgpMessage).then(function(plaintext) { - // success - }).catch(function(error) { - // failure - }); - +```js +var openpgp = require('openpgp'); +var key = '-----BEGIN PGP PRIVATE KEY BLOCK ... END PGP PRIVATE KEY BLOCK-----'; +var privateKey = openpgp.key.readArmored(key).keys[0]; +privateKey.decrypt('passphrase'); +var pgpMessage = '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----'; +pgpMessage = openpgp.message.readArmored(pgpMessage); +openpgp.decryptMessage(privateKey, pgpMessage).then(function(plaintext) { + // success +}).catch(function(error) { + // failure +}); +``` ### Security recommendations