Skip to content
This repository was archived by the owner on Mar 24, 2022. It is now read-only.

Commit 1104a87

Browse files
authored
Update DOCUMENTATION.md
1 parent 967a2b4 commit 1104a87

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

DOCUMENTATION.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ These are the guidelines for writing documentation for an example.
1313

1414
## Document flow
1515

16-
You can use this as a template:
16+
### Completed examples
17+
For completed examples you should use this as a template:
1718

1819
```markdown
1920
# Examples Project Name
20-
21-
**GIF OR IMAGE**
21+
![Example demo image](LINK TO IMAGE)
2222

2323
### Description
2424
...
@@ -46,6 +46,25 @@ Android ✅
4646
### Parameters
4747
...
4848

49+
```
50+
### In-Progress examples
51+
Examples which have yet to be finished are permitted to omit paramaters, but the demo image, supported aspect ratios and supported platforms must still be in the README. Use this as a template.
52+
53+
```markdown
54+
# Examples Project Name
55+
![Example demo image](LINK TO IMAGE)
56+
57+
### Description
58+
...
59+
60+
### Supported aspect ratios
61+
...
62+
63+
### Supported Platforms
64+
...
65+
66+
### Parameters
67+
4968
```
5069

5170
## Parameters

0 commit comments

Comments
 (0)