diff --git a/README.md b/README.md index ddec8f2..39f3e90 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,29 @@ -# sodium-javascript +# `sodium-javascript` -WIP - a pure javascript version of [sodium-native](https://github.com/mafintosh/sodium-native). +[![Build Status](https://travis-ci.org/sodium-friends/sodium-javascript.svg?branch=master)](https://travis-ci.org/sodium-friends/sodium-javascript) + +> WIP - a pure javascript version of [sodium-native](https://github.com/mafintosh/sodium-native). Based on tweetnacl -``` -npm install sodium-javascript -``` - ## Usage ``` js -var sodium = require('sodium-javascript') +const sodium = require('sodium-javascript') -var key = new Buffer(sodium.crypto_secretbox_KEYBYTES) -var nonce = new Buffer(sodium.crypto_secretbox_NONCEBYTES) +const key = Buffer.alloc(sodium.crypto_secretbox_KEYBYTES) +const nonce = Buffer.alloc(sodium.crypto_secretbox_NONCEBYTES) sodium.randombytes_buf(key) sodium.randombytes_buf(nonce) -var message = new Buffer('Hello, World!') -var cipher = new Buffer(message.length + sodium.crypto_secretbox_MACBYTES) +const message = Buffer.from('Hello, World!') +const cipher = Buffer.alloc(message.length + sodium.crypto_secretbox_MACBYTES) sodium.crypto_secretbox_easy(cipher, message, nonce, key) console.log('Encrypted:', cipher) -var plainText = new Buffer(cipher.length - sodium.crypto_secretbox_MACBYTES) +const plainText = Buffer.alloc(cipher.length - sodium.crypto_secretbox_MACBYTES) sodium.crypto_secretbox_open_easy(plainText, cipher, nonce, key) @@ -37,6 +35,12 @@ console.log('Plaintext:', plainText.toString()) See [sodium-native](https://github.com/mafintosh/sodium-native). This is a work in progress so all functions are not implemented yet. +## Install + +``` +npm install sodium-javascript +``` + ## License -MIT +[MIT](LICENSE)