Skip to content

Commit 7b84925

Browse files
authored
Add links definition (#57)
1 parent 6f69ab1 commit 7b84925

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

src/reference/manifest.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ The `manifest.json` file is the first file that is read by the Caido application
1313
"email": "dev@caido.io",
1414
"url": "https://github.com/caido-community/authmatrix"
1515
},
16+
"links": {
17+
"sponsor": "https://patreon.com/..."
18+
},
1619
"plugins": [
1720
{
1821
"kind": "frontend",
@@ -54,6 +57,7 @@ Here's a summary of each field (**required** fields are marked with an asterisk
5457
| name | No | The name of your plugin package. If not supplied, the `id` will be used as the `name`. |
5558
| description | No | A description of the plugin package . |
5659
| Author | No | See the [author fields](#author-fields). |
60+
| Links | No | See the [links fields] |
5761
| Plugins | Yes | Array of plugins. See the [plugin fields](#plugins-fields). |
5862

5963
## Author Fields
@@ -66,6 +70,14 @@ The `author` field is optional and may be used for crediting purposes.
6670
| email | No | The email address of the author. |
6771
| url | No | A URL to the author's website. |
6872

73+
## Links Fields
74+
75+
The `links` field is optional and is currently used to provide users with a funding link.
76+
77+
| Field | Required | Description |
78+
| ------- | -------- | --------------------------------------- |
79+
| sponsor | No | A URL to the project's funding website. |
80+
6981
## Plugins Fields
7082

7183
The `plugins` field is required and must contain an array of plugins.

0 commit comments

Comments
 (0)