From 4b4cbaaa3c0ceb74f4dee243eb4f35756424c72a Mon Sep 17 00:00:00 2001 From: Feross Aboukhadijeh Date: Tue, 7 Jan 2014 20:41:23 -0800 Subject: [PATCH] improve readme --- LICENSE.MIT | 2 +- README.md | 29 +++++++++++++++++++++-------- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/LICENSE.MIT b/LICENSE.MIT index 242132d..96d3f68 100644 --- a/LICENSE.MIT +++ b/LICENSE.MIT @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) +Copyright (c) 2014 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 1b4f3bc..ed31d1a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,31 @@ -Intro -===== +base64-js +========= + +`base64-js` does basic base64 encoding/decoding in pure JS. [![build status](https://secure.travis-ci.org/beatgammit/base64-js.png)](http://travis-ci.org/beatgammit/base64-js) [![testling badge](https://ci.testling.com/beatgammit/base64-js.png)](https://ci.testling.com/beatgammit/base64-js) -`base64-js` does basic base64 encoding/decoding in pure JS. Many browsers already have this functionality, but it is for text data, not all-purpose binary data. +Many browsers already have base64 encoding/decoding functionality, but it is for text data, not all-purpose binary data. Sometimes encoding/decoding binary data in the browser is useful, and that is what this module does. -API -=== +## install + +With [npm](https://npmjs.org) do: + +`npm install base64-js` + +## methods + +`var base64 = require('base64-js')` + +`base64` has two exposed functions, `toByteArray` and `fromByteArray`, which both take a single argument. + +* `toByteArray` - Takes a base64 string and returns a byte array +* `fromByteArray` - Takes a byte array and returns a base64 string -`base64-js` has two exposed functions, `toByteArray` and `fromByteArray`, which both take a single argument. +## license -* toByteArray- Takes a base64 string and returns a byte array -* fromByteArray- Takes a byte array and returns a base64 string +MIT \ No newline at end of file