BTCPrivate
/
lightningtip
mirror of https://github.com/BTCPrivate/lightningtip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fixed spelling mistakes in documentation

This commit is contained in:
michael1011 2018-03-29 18:22:09 +02:00
parent 426b0dc636
commit 6213ced383
No known key found for this signature in database
GPG Key ID: 84D249BA71685D46
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,7 +1,7 @@
# LightningTip
A simple way to accept tips via the Lightning Network on your website.
<img src="https://i.imgur.com/ghPu0SR.gif" width="240">
<img src="https://i.imgur.com/tTQnnoJ.gif" width="240">
## How to install
To get all necessary files for setting up LightningTip you can either [download a prebuilt version](https://github.com/michael1011/lightningtip/releases) or [compile from source](#how-to-install).
@ -13,10 +13,10 @@ LightningTip is using [LND](https://github.com/lightningnetwork/lnd) as backend.
The default config file location is `lightningTip.conf` in the directory you are executing LightningTip in. The [sample config](https://github.com/michael1011/lightningtip/blob/master/sample-lightningTip.conf) contains everything you need to know about the configuration. To use a custom config file location use the flag `--config filename`.
Embedding LightningTip is also quite easy. Upload all files excluding `lightningTip.html` to your webserver. Copy the contents of the head tag of the before mentioned HTML file into a HTML you want to show LightningTip in. The div below the head tag is LightningTip itself. Paste it into any place in the already edited HTML file on you server.
Embedding LightningTip is also quite easy. Upload all files excluding `lightningTip.html` to your webserver. Copy the contents of the head tag of the before mentioned HTML file into a HTML file you want to show LightningTip in. The div below the head tag is LightningTip itself. Paste it into any place in the already edited HTML file on you server.
If you are not running LightningTip on the same domain or IP address as your werbserver or not on port 8081 change the variable `requestUrl` (which is in the first line) in the file `lightningTip.js` accordingly.
If you are not running LightningTip on the same domain or IP address as your webserver or not on port 8081 change the variable `requestUrl` (which is in the first line) in the file `lightningTip.js` accordingly.
That's it! The only two things you need to take care about is keeping the LND node online and making sure that your channels are funded well enough to receive tips. LightningTip will take care of everything else.
@ -26,6 +26,7 @@ First of all make sure [Golang](https://golang.org/) and [Dep](https://github.co
```
go get github.com/michael1011/lightningtip.git
cd $GOPATH/src/github.com/michael1011/lightningtip.git
dep ensure
go install
```

2
frontend/lightningTip.js
View File

@ -1,3 +1,5 @@
// Edit this variable if you are not running LightningTip on the same domain or IP address as your webserver or not on port 8081
// Don't forget the "/" at the end!
var requestUrl = window.location.protocol + "//" + window.location.hostname + ":8081/";
// To prohibit multiple requests at the same time