Updated README

README.md

@@ -1,4 +1,56 @@
+[![Build Status](https://travis-ci.org/riyadhalnur/node-base64-image.svg?branch=master)](https://travis-ci.org/riyadhalnur/node-base64-image)  
+
 node-base64-image
 =================
 
 Download images from remote URLs and encode/decode them to base64
+
+To install  
+`npm install node-base64-image --save`  
+
+To run tests  
+`npm test`  
+
+### Usage  
+
+Require the library in your .js file  
+`var base64 = require('node-base64-image');`  
+
+#### Download and encode an image  
+```  
+var options = {string: true}  
+
+base64.base64encode('www.someurl.com/image.jpg', function (err, image) {  
+    if (err) { console.log(err); }  
+    console.log(image);  
+});  
+```
+
+##### Parameters  
+url (string) - the url of the image to be downloaded and encoded.
+options (object) - if string is passed is with 'true', the image returned will be a base64 string. Otherwise, the base64 buffer is returned.  
+callback (function) - the callback will contain the err object and the encoded image object.  
+
+#### Decode and write a base64 encoded image to disk  
+```  
+var options = {filename: 'test'}; 
+var imageData = new Buffer('/9j/4AAQSkZJRgABAQAAAQABAAD...', 'base64'); 
+
+base64.base64decode(imageData, options, function (err, saved) {
+    if (err) { console.log(err); }  
+    console.log(saved);    
+});  
+```  
+
+##### Paramaters  
+imageData (buffer) - the base64 image buffer.  
+options (object) - contains the 'filename' property; this will be the written image file.  
+callback (function) - the callback will contain the err object and the 'successful save' string. 
+
+### License  
+This library is licensed under the GPL v3.0 license.  
+
+### Issues  
+Report a bug in the issues.   
+
+Lovingly crafted in Dhaka, Bangladesh by [Riyadh Al Nur](http://blog.verticalaxisbd.com)