Add readme

README.md

@@ -0,0 +1,82 @@
+# LnTip - your friendly lightning tipping widget
+
+LnTip provides a Bitcoin lightning tipping widget that can easily be integrated into any website.  
+
+It consistes of a small service written in Go that connects to a lnd node and exposes 
+a simple HTTP JSON API to create and monitor invoices. This API is used from a tiny 
+JavaScript widget that integrated in any website. 
+
+See it in action: [moneyz.michaelbumann.com](http://moneyz.michaelbumann.com)
+
+## Motivation
+
+Besides experimenting with lnd and Go... :) I wanted a simple tipping button for my website 
+that uses my own lightning node and does not rely on external services.  
+
+## Installation
+
+To use LnTip a running [LND node](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md) 
+is required.  
+
+1. download the latest [release](https://github.com/bumi/lntip/releases)
+2. run `lntip` 
+3. integrate the widget on website
+
+### Configuration
+
+To connect to the lnd node the cert, macaroon and address of the lnd node has to be configured:
+
+* address: Host and port of the lnd gRPC service. default: localhost:10009
+* cert: Path to the lnd cert file. default: ~/.lnd/tls.cert
+* macaroon: Path to the macaroon file. default: ~/.lnd/data/chain/bitcoin/mainnet/invoice.macaroon
+* bind: Host and port to listen on. default: :1323 (localhost:1323)
+
+Example: 
+
+    $ ./lntip --address=lndhost.com:10009 --bind=localhost:4711
+    $ ./lntip --help
+
+### JavaScript Widget integration
+
+Load the JavaScript file in your HTML page and configure the `lntip-host` attribute 
+to the host and port on which your lntip instance is running:
+
+```html
+<script lntip-host="https://your-lntip-host.com:1323" src="https://cdn.jsdelivr.net/gh/bumi/lntip/assets/lntip.js" id="lntip-script"></script>
+```
+
+#### Usage
+
+```js
+new LnTip({ amount: 1000, memo: 'high5' }).request()
+```
+
+```js
+let tip = new LnTip({ amount: 1000, memo: 'high5' });
+
+// get a new invoice and watch for a payment
+// promise resolves if the invoice is settled
+tip.requestPayment().then((invoice) => {
+  alert('YAY, thanks!');
+});
+
+// create a new invoice
+tip.getInvoice().then((invoice) => {
+  console.log(tip.invoice.PaymentRequest)
+});
+
+// periodically watch if an invoice is settled
+tip.watchPayment().then((invoice) => {
+  alert('YAY, thanks!');
+});
+
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/lntip
+
+## License
+
+Available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).