commit 747672e2f845074f2e9f9fa4a14055d324098975
parent 97d84bc54bde0d2fbf6d3e006f50f6db986e8421
Author: Erica Xu <iam@ericaxu.com>
Date: Mon, 5 Dec 2022 15:57:04 -0500
Merge pull request #42 from obsidianmd/funding-url
Add funding URL documentation
Diffstat:
1 file changed, 23 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -67,6 +67,29 @@ Quick starting guide for new plugin devs:
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
- `eslint .\src\`
+## Funding URL
+
+You can include funding URLs where people who use your plugin can financially support it.
+
+The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
+
+```json
+{
+ "fundingUrl": "https://buymeacoffee.com"
+}
+```
+
+If you have multiple URLs, you can also do:
+
+```json
+{
+ "fundingUrl": {
+ "Buy Me a Coffee": "https://buymeacoffee.com",
+ "GitHub Sponsor": "https://github.com/sponsors",
+ "Patreon": "https://www.patreon.com/"
+ }
+}
+```
## API Documentation
