Skip to content

Commit 8f33edb

Browse files
committed
Changes to more pages
1 parent d61e26c commit 8f33edb

3 files changed

Lines changed: 36 additions & 9 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
<a href="https://lnbits.com" target="_blank" rel="noopener noreferrer">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/QE6SIrs.png">
4+
<img src="https://i.imgur.com/fyKPgVT.png" alt="LNbits" style="width:280px">
5+
</picture>
6+
</a>
7+
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-success?logo=open-source-initiative&logoColor=white)](./LICENSE)
9+
[![Built for LNbits](https://img.shields.io/badge/Built%20for-LNbits-4D4DFF?logo=lightning&logoColor=white)](https://github.com/lnbits/lnbits)
10+
111
# Example Extension - <small>[LNbits](https://github.com/lnbits/lnbits) extension</small>
212

313
<small>For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)</small>
@@ -11,3 +21,10 @@ Try to include an image
1121
<h2>If your extension has API endpoints, include useful ones here</h2>
1222

1323
<code>curl -H "Content-type: application/json" -X POST https://YOUR-LNBITS/YOUR-EXTENSION/api/v1/EXAMPLE -d '{"amount":"100","memo":"example"}' -H "X-Api-Key: YOUR_WALLET-ADMIN/INVOICE-KEY"</code>
24+
25+
## Powered by LNbits
26+
27+
[LNbits](https://lnbits.com) is a free and open-source lightning accounts system.
28+
29+
[![Visit LNbits Shop](https://img.shields.io/badge/Visit-LNbits%20Shop-7C3AED?logo=shopping-cart&logoColor=white&labelColor=5B21B6)](https://shop.lnbits.com/)
30+
[![Try myLNbits SaaS](https://img.shields.io/badge/Try-myLNbits%20SaaS-2563EB?logo=lightning&logoColor=white&labelColor=1E40AF)](https://my.lnbits.com/login)

config.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
{
2+
"id": "example",
3+
"version": "1.0.6",
24
"name": "Build your own!",
5+
"repo": "https://github.com/lnbits/example",
36
"short_description": "Extension building guide",
7+
"description": "",
48
"tile": "/example/static/bitcoin-extension.png",
59
"min_lnbits_version": "1.0.0",
6-
"donate": "donate@legend.lnbits.com",
710
"contributors": [
811
{
912
"name": "Ben Arc",
@@ -29,5 +32,9 @@
2932
],
3033
"description_md": "https://raw.githubusercontent.com/lnbits/example/main/description.md",
3134
"terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/example/main/toc.md",
32-
"license": "MIT"
35+
"license": "MIT",
36+
"paid_features": "",
37+
"tags": ["Utilities", "Developer"],
38+
"donate": "",
39+
"hidden": false
3340
}

description.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
An easily clonable extension that can be used a base for building a new extension.
1+
A starter template for developers to build new LNbits extensions.
22

3-
THe usual development enviroment is:
3+
Its functions include:
44

5-
- Clone the myextension repo to your own repo
6-
- Edit the cloned repos manifest to your details
7-
- Install into LNbits
8-
- Delete the cloned extensions folder in your LNbits install
9-
- Create a symbolic link to the extensions folder, from the where you have pulled your extension `ln -s /where/you/cloned/myextension /your/lnbits/installl/lnbits/lnbits/extensions/`
5+
- Providing a clonable base structure for new extensions
6+
- Demonstrating LNbits extension patterns and best practices
7+
- Including example API endpoints and database models
8+
- Supporting symbolic linking for local development
9+
10+
The recommended starting point for developers who want to create custom LNbits extensions with proper structure and conventions.
11+
12+
Note: If you are using LLMs to generate Code, please use our Instructions to feed your Modal.

0 commit comments

Comments
 (0)