https://github.com/podverse/webln-v4v
A library for injecting a form for sending Value-4-Value Bitcoin Lightning payments with an LNURL compatible browser extension
https://github.com/podverse/webln-v4v
Last synced: about 1 year ago
JSON representation
A library for injecting a form for sending Value-4-Value Bitcoin Lightning payments with an LNURL compatible browser extension
- Host: GitHub
- URL: https://github.com/podverse/webln-v4v
- Owner: podverse
- License: other
- Created: 2022-05-14T11:31:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T21:46:58.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T12:20:58.832Z (almost 2 years ago)
- Language: Svelte
- Homepage:
- Size: 557 KB
- Stars: 8
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# 🏗 webln-v4v
[](https://github.com/podverse/webln-v4v/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/webln-v4v) [](https://github.com/podverse/webln-v4v/blob/main/LICENSE.md) [](https://svelte.dev/) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io)
A library for easily rendering a form on-page that lets your webpage visitors send Bitcoin Lightning payments with a WebLN compatible browser extension. This library is intended to be used with the Podcasting 2.0 RSS namespace for keysend payments..
## DISCLAIMER 🚨🚨🚨
This is an experimental library. The software is provided AS-IS, we make no guarantees of its reliability, we are not responsible if your funds go missing or are sent to the wrong address, and you and your users assume all risks associated with using it.
## Quick Start
The best place to start is with the [quick start guide](https://github.com/podverse/webln-v4v/blob/main/docs/quick-start.md). Hopefully it's as easy as copy/pasting a few lines into html.
## Supported Browser Extensions
This widget will only render on a web page if it detects that the user has an [LNURL](https://github.com/fiatjaf/lnurl-rfc) compatible browser extension installed.
Currently supported browser extensions include:
[Alby](https://github.com/getAlby/lightning-browser-extension)
## Attribution / Donate to Patrick
Thank you to [@ptkdev](https://github.com/ptkdev) for creating the [svelte-webcomponent-boilerplate](https://github.com/ptkdev-boilerplate/svelte-webcomponent-boilerplate). This project was built on top of this boilerplate. Please consider [donating to Patrick](https://github.com/ptkdev) for his great work.
## Support Podverse
> Podverse is **free** / **open source** / **copylefted libre** software, and we would greatly appreciate your donations or pull requests 🙏
[](https://www.paypal.com/donate?hosted_button_id=YKMNUDUCRTUPC) [](https://www.patreon.com/podverse) [](https://ptk.dev/img/icons/menu/bitcoin_wallet.png)
## 📎 Menu
- 💡 [Features](#-features)
- 🕹 Demo - TODO: coming soon
- 👔 Screenshot - TODO: coming soon
- 🚀 [How to use](#-installation)
- - 🌎 [Web](#-installation-web)
- - 📦 [Webpack/Browserify](#-installation-npm-module---browserifywebpack)
- - 📖 [Wordpress](#-installation-wordpress)
- - 🔵 [React](#-installation-react)
- - 🔴 [Angular](#-installation-angular)
- - 🟠 [Svelte](#-installation-svelte)
- - 🟢 [Vue](#-installation-vue)
- 📚 [Documentation](#-documentation)
- - 🧰 [Options / Attributes](#-options--attributes)
- - 🎨 [CSS Customization](#-css-customization)
- 🔨 [Developer Mode](#-developer-mode)
- - 🏁 [Run Project](#-run-project)
- - 💾 [Setup Project](#-setup-project)
- 🐛 [Known Bugs](https://github.com/podverse/webln-v4v/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
- 🍻 Community:
- 
[Discord](https://discord.com/invite/6HkyNKR))
- 
[Twitter](http://twitter.com/podverse)
## 💡 Features
- [✔️] Easy to use
- [✔️] MIT License
- [✔️] Text animation by [Nooray Yemon](https://codepen.io/yemon) on [Codepen](https://codepen.io/yemon/pen/pWoROm)
- [✔️] Friendly boilerplate + Github templates
- [✔️] Powered by svelte framework
- [✔️] Without jQuery depencence
- [✔️] Configurable with attributes
- [✔️] Customization with CSS Style
- [✔️] HTML5 Custom Elements - Native webcomponents
- [✔️] Work with: Browserify / Webpack / ReactJS / Svelte / Angular / Vue / Wordpress
- [✔️] Typescript + TSPaths preconfigured
- [✔️] Userfriendly folders tree
- [✔️] Prettiers and ESLint preconfigured
- [✔️] all-contributors-cli and all-shields-cli preconfigured
- [✔️] JEST Test preconfigured
- [✔️] Full async code
- [✔️] Github and Vscode dotfiles preconfigured
- [✔️] Translations i18n (Help me ❤️)
## 🚀 Installation (Web)
1. Add html code to your page:
```html
```
2. Require javascript in yourpage (before `