Browse Source

feat: document how to contribute

Signed-off-by: QuentinN42 <quentin@lieumont.fr>
master
QuentinN42 7 months ago
parent
commit
9c45b07869
Signed by untrusted user: number42 GPG Key ID: 2CD7D563712B3A50
  1. 18
      README.md

18
README.md

@ -2,3 +2,21 @@
Create a sample website from a json.
Read the `config.json` file to configure the website.
## How to add my website ?
1. Fork this repository.
2. Add this json in the `config.json` file.
```json
{
"url": "https://TODO.fr",
"image": "./static/TODO.png",
"name": "TODO",
"description": "TODO"
}
```
3. Add the image in the `static` folder.
4. Commit and push.
5. Create an MR on the `master` branch.

Loading…
Cancel
Save