Skip to content

Commit 3bb919c

Browse files
committed
docs: Fix up the template significantly.
1 parent 7e769f8 commit 3bb919c

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

data/libraries/TEMPLATE.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,42 @@
11
# Template
22

3-
> **NOTE**: Max 25 lines for description.
3+
# Required fields
4+
5+
The `name`, `url` and `fields` fields are required.
6+
7+
# Types
8+
9+
- The `fields` field must be an array of strings and/or objects containing a `name` and a `value`.
10+
- The `colour` field should be a hexadecimal colour, a named colour (e.g. `RED`), or `RANDOM`.
11+
- The `icon` field is the filename (+ extension) of the icon in `assets/images/icons/`.
12+
- The `author.avatar` field should optionally be the filename (+ extension) of the avatar in `assets/images/avatars/`.
13+
- The `tags` field should be an array of strings containing arbitrary tags.
14+
15+
---
416

517
```json
618
{
7-
"name": "",
8-
"tagline": "",
9-
"tags": ["..."],
10-
"icon": "",
19+
"name": "Example Library",
20+
"tagline": "Example Library solves your problems",
21+
"tags": ["ui", "component", "library", "material", "design"],
22+
"icon": "example-library.png",
23+
"colour": "RANDOM",
1124
"url": {
12-
"site": "",
13-
"docs": "",
14-
"repo": "",
15-
"bugs": ""
25+
"site": "https://www.example.com/example-library/site",
26+
"docs": "https://www.example.com/example-library/docs",
27+
"repo": "https://www.example.com/example-library/code",
28+
"bugs": "https://www.example.com/example-library/bugs"
1629
},
17-
"fields": ["..."],
30+
"fields": [
31+
{ "name": "Fast", "value": "Example Library is fast" },
32+
{ "name": "Easy", "value": "Example Library is easy to use" },
33+
{ "name": "Secure", "value": "Example Library is safe" },
34+
"Use Example Library today!"
35+
],
1836
"author": {
19-
"name": "",
20-
"url": "",
21-
"avatar": ""
37+
"name": "Example Author",
38+
"url": "https://www.example.com/users/example-author",
39+
"avatar": "example-author.png"
2240
}
2341
}
2442
```

0 commit comments

Comments
 (0)