added examples for Projects and Team Members

This commit is contained in:
AtHeartEngineer
2022-05-31 17:19:58 -04:00
committed by GitHub
parent 5043178856
commit b672e7be7e

57
src/data/Example.md Normal file
View File

@@ -0,0 +1,57 @@
# Examples
## Project Example
```json
{
"name": "Test",
"short_name": "TEST",
"description": "Black Magic",
"long_description": "Black Magic",
"image": "banner.png",
"links": [
{
"website": "https://discord.gg"
},
{
"twitter": "https://discord.gg/1"
},
{
"telegram": "https://discord.gg/2"
},
{
"discord": "https://discord.gg/3"
},
{
"github": "https://discord.gg/4"
}
]
}
```
## Team Member Example
```json
{
"name": "NAME / USERNAME",
"description": "Whatever description you want, try to keep it tweet sized",
"image": "{filename}(Upload image to /src/images and put the file name here, will add support for external images soon)",
"links": [
{
"github": "https://github.com/USERNAME"
},
{
"twitter": "https://twitter.com/USERNAME"
},
{
"discord": "https://discord.com//users/USER_ID (NOT USERNAME, https://i.imgur.com/6CDZ1dp.gifv for how-to)"
},
{
"telegram": "t.me/USERNAME"
},
{
"website": "{YOUR_WEBSITE}"
}
]
}
```