Skip to content

Commit

Permalink
updated readme with examples
Browse files Browse the repository at this point in the history
  • Loading branch information
pkrumins committed Jul 10, 2010
1 parent 4d8827c commit 5269d71
Showing 1 changed file with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions readme.txt
@@ -1,6 +1,5 @@
This is a node.js C++ module that encodes buffers to base64. And compared to This is a node.js C++ module that encodes and decodes to/from base64. Oh, and
all other modules, it works. It does not provide decode functionality because compared to all other modules, it actually works.
I don't currently need it.


It was written by Peteris Krumins (peter@catonmat.net). It was written by Peteris Krumins (peter@catonmat.net).
His blog is at http://www.catonmat.net -- good coders code, great reuse. His blog is at http://www.catonmat.net -- good coders code, great reuse.
Expand All @@ -12,11 +11,43 @@ To build the module run:
node-waf configure build node-waf configure build


This will produce `base64.node` binary module. To use it, make sure the This will produce `base64.node` binary module. To use it, make sure the
module's directory is in NODE_PATH and then just do the usual: module's directory is in NODE_PATH.


The module exports two functions `encode` and `decode`.

encode
------

Encodes a buffer to base64, returns encoded ascii string. Unlike all other
base64, it actually works well with binary data. If you're wondering why it
takes a buffer as argument, it's because there is no way to pass binary
strings to C++ code in a sane way.

Here is a basic example:

var sys = require('sys');
var base64_encode = require('base64').encode; var base64_encode = require('base64').encode;
var Buffer = require('buffer').Buffer;

var buf = new Buffer('hello world');

sys.print(base64_encode(buf));

/* Output: aGVsbG8gd29ybGQ= */


decode
------

Decodes a buffer containing base64 string, or just a base64 string to original
data.

var sys = require('sys');
var base64_decode = require('base64').decode;

sys.print(base64_decode('aGVsbG8gd29ybGQ='));


Now you can pass base64_encode the buffers to convert to base64. /* Output: hello world */




------------------------------------------------------------------------------ ------------------------------------------------------------------------------
Expand Down

0 comments on commit 5269d71

Please sign in to comment.