Skip to content

CHORE Fix github alert syntax, typos, etc #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PatMulligan wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −7
Open

CHORE Fix github alert syntax, typos, etc #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
`The README.md typically serves as a guide for using the extension.`
> [!NOTE]
> The README.md typically serves as a guide for using the extension.

# MyExtension - An [LNbits](https://github.com/lnbits/lnbits) Extension

> [!IMPORTANT]
> This guide assumes you're using this extension as a base for a new one, and have installed LNbits using <https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md#option-1-recommended-poetry>.

## A Starter Template for Your Own Extension

Ready to start hacking? Once you've forked this extension, you can incorporate functions from other extensions as needed.

### How to Use This Template

> [!IMPORTANT] the sequence of steps is very important so as not to run into issues!
> [!IMPORTANT]
> Follow the sequence of steps to avoid running into issues!

> [!NOTE] You may want to modify your models.py/migration.py before installing the extension on your lnbits server (between steps

> This guide assumes you're using this extension as a base for a new one, and have installed LNbits using <https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md#option-1-recommended-poetry>.
> [!NOTE]
> You may want to modify your models.py/migration.py before installing the extension on your lnbits server

1. Fork this extension to your Github repo with the name you want, e.g., `yourextensionname` -> <https://github.com/yourgithubusername/yourextensionname> (do not include hyphens as they can cause issues!)

Expand All @@ -30,7 +34,7 @@ Ready to start hacking? Once you've forked this extension, you can incorporate f

1. Push to your github repo

1. [!IMPORTANT] **you must create a release** _in your github repo_ in order for it to show up in your lnbits extensions!
1. **⚠️ IMPORTANT:** You must create a release in your github repo in order for it to show up in your lnbits extensions!

1. Start up your lnbits server and go to the Settings -> EXTENSIONS and add your manifest to the extension sources. It should be `https://raw.githubusercontent.com/<yourgithubusernaame>/<yourextensionname>/main/manifest.json` (going to this link should show your updated manifest) and **save**. ![Extension Sources](https://i.imgur.com/MUGwAU3.png)
1. Great! Now if you go to the **Extensions** and go to the **ALL** tab, you should see your extension available for installing! (note that Github has an API rate limit, and you may want to include an API key generated from your github account in the `.env` file)
Expand All @@ -41,4 +45,4 @@ Ready to start hacking? Once you've forked this extension, you can incorporate f

1. Restart your LNbits installation. You can now modify your extension and the changes will appear on your LNbits instance (stop & restart your lnbits for full initialization of all files if needed, e.g., for migration to take effect). You can also `git push` changes to your new repo and create a release _in your github repo_ if you want to install it from a fresh lnbits!

1. 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>
1. **⚠️ 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>
Loading