diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 14 insertions, 6 deletions
@@ -1,19 +1,27 @@ # Bitcoin Point of Sale -This is a simple utility that a merchant can run on a tablet or phone to convert dollars to bitcoins and receive payments from clients +This is a simple utility that a merchant can run on a tablet or phone to convert dollars to bitcoins and receive payments from clients. A setup page allows you to configure the company title, logo, address, exchange rate, and commission. -It uses the websocket payment notification API from http://blockchain.info/ to display notifications in real time. +We use the websocket payment notification API from http://blockchain.info/api/api_websocket to listen for and display payment notifications in real time. The bitcoin exchange rates are fetched from http://bitcoincharts.com/. -# Installation +When transactions are detected, they are logged along with the time and current exchange rate, and a report is provided so that merchants can account for how many bitcoins they received in a given time period and see their equivalent dollar value. If desired, merchants can then keep a cash float on hand and instruct cashiers to convert the received bitcoins to dollars on-premise at the time of payment, daily, weekly, monthly or as desired. -Download market price data into a file called `ticker.json`: +# Installation - curl "http://bitcoincharts.com/t/depthcalc.json?symbol=virtexCAD&type=bid&amount=1000¤cy=true" > ticker.json +The main calculator page `calculator.html` is programmed in HTML5 and should run in any modern browser. The transaction logging and reporting functionality requires a data store. It's currently using PHP to write to flat JSON files but am probably going to switch to NodeJS and MySQL. # Demo Instance -http://bitcoin.adamsoltys.com/ +http://vanbtc.ca/ + +# Todo +* Allow calculator configurations to be saved and assigned to an account +* Short/pretty URLs for pre-saved configurations +* Security/authentication around transaction logging +* Verify transaction logs against the blockchain +* More robust disconnect and error handling +* Better device detection and browser testing # License |