## Introduction **bitcoinaddress.js** is a a JavaScript component library for making easy bitcoin payments, sending bitcoins and presenting bitcoin addresses on HTML pages. ![image](https://ci.testling.com/miohtama/bitcoinaddress.js.png) ## Features * Mobile and touch friendly - no pop-ups * Use [Bitcoin URI protocol](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) to make payments from your desktop, web or mobile bitcoin wallet * Generate QR codes in-fly with JavaScript to make payments from mobile applications * Copy Bitcoin address to the clipboard * Customize and extend easily with custom DOM templates and JavaScript hooks ## Demos [See the demo](http://miohtama.github.com/bitcoinaddress.js/index.html). * [Liberty Music Store is an online store which allows musicians to sell their songs and receive Bitcoins.](https://libertymusicstore.net/). The source code of Liberty Music Store is [on Github](https://github.com/miohtama/LibertyMusicStore), so you can check it for the integration example. * The sister project [bitcoinaaddress.js for making bitcoin payments and QR codes](https://github.com/miohtama/bitcoinaddress.js). ## Installation No server-side components needed. You must have [jQuery](http://jquery.com) (version 1.9 or later) installed. Drop `bitcoinaddress.js` on your HTML page with optio elements as described below. Download minified or debug bundle from [Github dist folder](https://github.com/miohtama/bitcoinaddress.js/tree/master/dist) The bundle includes QRCode.js library (see below). ## How it works * Include `bitcoinaddress.js` on your HTML page * Configure and initialize it with a ` ``` A DOM templating is used to built the controls for the Bitcoin addresses. Embed the following snippet hidden in and customize for your needs. See [index.html](https://github.com/miohtama/bitcoin-prices/blob/master/index.html) for example CSS styles: ```html ``` Then you can have Bitcoin addresses on your page, with or without payment amounts. Plain Bitcoin address example: ```html 19356KxTs9Bw5AAdxens5hoxDSp5bsUKse ``` Bitcoin address with payment amount example: ``` 19356KxTs9Bw5AAdxens5hoxDSp5bsUKse ``` See the demo how to nominate the payment in the fiat currency using [bitcoinprices.js](https://github.com/miohtama/bitcoin-prices) library. ### Supported data attributes The following HTML5 data attributes are supported on `.bitcoin-address` elements * `data-bc-address` - bitcoin address for programmatical manipulation, **required** * `data-bc-amount` - suggestion how much to send * `data-bc-label` - address label in the wallet * `data-bc-message` - transaction message ## NPM packaging This project is also packaged and distributed on [npmjs.org](https://npmjs.org/). You can install the package with [browserify](http://browserify.org/) and various other tools to include it in app JavaScript stack. ## Other [See also bitcoin-prices.js JavaScript project for presenting Bitcoin prices in human-friendly manner and alternative currencies like USD and EUR](https://github.com/miohtama/bitcoin-prices). [Bitcoin URL scheme explained](http://bitcoin.stackexchange.com/questions/4987/bitcoin-url-scheme). [Bitcoin URIs in Electrum](https://electrum.org/bitcoin_URIs.html). [QRCode.js - generate QR codes in JavaScript](https://github.com/davidshimjs/qrcodejs) by [Shim Sangmin](https://github.com/davidshimjs). ## Development NPM + Node required. A `Makefile` provides many commands to develop, test and publish this project. [browserify](https://github.com/substack/node-browserify) used for client-side module imports. Install dependencies locally: ``` make setup ``` Run the development server with auto-reload (save `bitcoinaddress.js` in your text editor and the browser will reload `index.html`): ``` make dev-server ``` Run unit tests locally: ``` make test-server ``` Make a release: ``` make publish ``` ## Internals and the development toolchain This package uses NPM, [browserify for JavaScript dependencies](http://browserify.org/), [beefy development server](https://github.com/chrisdickinson/beefy), [uglify-fs](http://lisperator.net/uglifyjs/) JavaScript minimizer. [tape](https://github.com/substack/tape) unit testing framework runs the tests on [testling](http://testling.com/) continuous integration service infrastructure. Check out `Makefile` if you want to learn how to use these tools. ## Author Mikko Ohtamaa ([blog](https://opensourcehacker.com), [Facebook](https://www.facebook.com/?q=#/pages/Open-Source-Hacker/181710458567630), [Twitter](https://twitter.com/moo9000), [Google+](https://plus.google.com/u/0/103323677227728078543/)) Contact for work and consulting offers.