From b376f9c4285da24d0f90765674ab315ed65c4741 Mon Sep 17 00:00:00 2001 From: Erica Xu Date: Mon, 5 Dec 2022 15:49:16 -0500 Subject: [PATCH 1/2] Add funding URL documentation --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index b8f865d..9433b8d 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,24 @@ 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 in your `manifest.json` file. + +If you have multiple URLs, you can also do: + +```json +{ + "authorUrl": "https://obsidian.md", + "fundingUrl": { + "Buy Me a Coffee": "https://buymeacoffee.com", + "GitHub Sponsor": "https://github.com/sponsors", + "Patreon": "https://www.patreon.com/" + } +} +``` ## API Documentation From d3bb1e67758e99b302d72f06f2400113fb226658 Mon Sep 17 00:00:00 2001 From: Erica Xu Date: Mon, 5 Dec 2022 15:55:39 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9433b8d..31e5155 100644 --- a/README.md +++ b/README.md @@ -71,13 +71,18 @@ Quick starting guide for new plugin devs: You can include funding URLs where people who use your plugin can financially support it. -The simple way is to set the `fundingUrl` field in your `manifest.json` file. +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 { - "authorUrl": "https://obsidian.md", "fundingUrl": { "Buy Me a Coffee": "https://buymeacoffee.com", "GitHub Sponsor": "https://github.com/sponsors",