lnbits-exts/satmachineclient
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

proofed

Browse source
This commit is contained in:
arcbtc 2023-12-28 15:34:09 +00:00
parent ecc5fc2d16
commit eaef267529
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,21 +1,21 @@
# Temp - <small>[LNbits](https://github.com/lnbits/lnbits) extension</small>
# Temp - An [LNbits](https://github.com/lnbits/lnbits) Extension
<small>For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)</small>
For more information about LNBits extensions, refer to [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions).
## A template extension you can fork and use as a base for a template
## A Starter Template for Your Own Extension
Let the hacking begin! After you have forked this extension you can copy functions from other extensions that you might need.
Ready to start hacking? Once you've forked this extension, you can incorporate functions from other extensions as needed.
The extension README is usually used as a guide of how to use the extension.
This README typically serves as a guide for using the extension.
### Usage
> We are assumng you want to use this extension as a base for a new extension
### How to Use This Template
> This guide assumes you're using this extension as a base for a new one.
1. Install then enable the extension either through the official LNbits manifest of by adding https://raw.githubusercontent.com/lnbits/temp/main/manifest.json to `"Server"/"Server"/"Extension Sources"`. <img src="https://i.imgur.com/MUGwAU3.png">
2. Shutdown your LNbits install.
3. Download the extension files from https://github.com/lnbits/temp to a folder outside of `/lnbits`, and initialise the folder with `git`. Or create a repo, copy the temp extension files into it, then `git clone` the extension to a location outside of `/lnbits`.
4. Delete the installed extension from `lnbits/lnbits/extenions`.
5. Create a symbolic link `ln -s /home/ben/Projects/temp /home/ben/Projects/lnbits/lnbits/extensions`.
6. Start your LNbits install (Now you can edit your extension).
7. Once you are ready to share your manifest so others can install edit `/lnbits/temp/manifest.json` to the git credentials of your extension.
8. IMPORTANT: If you intend the extension to be added to the offial LNbits manifest, please follow the guidlines here https://github.com/lnbits/lnbits-extensions#important
1. Install and enable the extension either through the official LNbits manifest or by adding https://raw.githubusercontent.com/lnbits/temp/main/manifest.json to `"Server"/"Server"/"Extension Sources"`. ![Extension Sources](https://i.imgur.com/MUGwAU3.png)
2. Shut down your LNbits installation.
3. Download the extension files from https://github.com/lnbits/temp to a folder outside of `/lnbits`, and initialize the folder with `git`. Alternatively, create a repo, copy the temp extension files into it, then `git clone` the extension to a location outside of `/lnbits`.
4. Remove the installed extension from `lnbits/lnbits/extensions`.
5. Create a symbolic link using `ln -s /home/ben/Projects/<name of your extension> /home/ben/Projects/lnbits/lnbits/extensions`.
6. Restart your LNbits installation. You can now modify your extension and `git push` changes to a repo.
7. When you're ready to share your manifest so others can install it, edit `/lnbits/temp/manifest.json` to include the git credentials of your extension.
8. IMPORTANT: If you want your extension to be added to the official LNbits manifest, please follow the guidelines here: https://github.com/lnbits/lnbits-extensions#important