Skip to content

Commit cd7cb96

Browse files
author
John Kleinschmidt
committed
Add info about screenshots
1 parent 43cdf10 commit cd7cb96

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

contributing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,17 @@ YML file rules:
8080
- `repository` is optional, but must be a fully-qualified URL if provided.
8181
- `keywords` is optional, but should be an array if provided.
8282
- `license` is optional.
83+
- `screenshots` are optional, but should be an array in the following format if provided:
84+
```
85+
screenshots:
86+
-
87+
imageUrl: 'https://mysite/awsome.png'
88+
caption: 'Awesome screenshot'
89+
imageLink: 'https://mysite/awesome.html'
90+
```
91+
* `imageUrl` - *required* - fully-qualified URL of screenshot image. Allowed image types are png, jpg, and gif.
92+
* `caption` - an optional caption to display with the screenshot.
93+
* `imageLink` - an optional link URL to indicate the link that should be directed to when someone clicks on an image. If this field is not specified, clicking on a screenshot will go to the application website.
8394
- No fields should be left blank.
8495

8596
Icon file rules:

readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ name: Hyper
2727
description: 'HTML/JS/CSS Terminal'
2828
website: 'https://hyper.is'
2929
repository: 'https://github.com/zeit/hyper'
30+
category: 'Developer Tools'
3031
```
3132
3233
Humans can include other data like `keywords` and `license`, but they're not required to do so.

0 commit comments

Comments
 (0)