Skip to content

Commit 747672e

Browse files
authored
Merge pull request #42 from obsidianmd/funding-url
Add funding URL documentation
2 parents 97d84bc + d3bb1e6 commit 747672e

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,29 @@ Quick starting guide for new plugin devs:
6767
- 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:
6868
- `eslint .\src\`
6969

70+
## Funding URL
71+
72+
You can include funding URLs where people who use your plugin can financially support it.
73+
74+
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
75+
76+
```json
77+
{
78+
"fundingUrl": "https://buymeacoffee.com"
79+
}
80+
```
81+
82+
If you have multiple URLs, you can also do:
83+
84+
```json
85+
{
86+
"fundingUrl": {
87+
"Buy Me a Coffee": "https://buymeacoffee.com",
88+
"GitHub Sponsor": "https://github.com/sponsors",
89+
"Patreon": "https://www.patreon.com/"
90+
}
91+
}
92+
```
7093

7194
## API Documentation
7295

0 commit comments

Comments
 (0)