Create CONTRIBUTING.md

This commit is contained in:
Mayhem 2014-09-11 03:56:26 +02:00
parent ce3c42a82c
commit 53cff2516d

24
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,24 @@
Generic archive information:
```json
{
"uid": 1234,
"name": "Archive Name",
"domain": "example.com",
"http": true,
"https": true,
"software": "foolfuuka",
"boards": ["a"],
"files": ["a"]
}
```
Most entries should be self-explanatory.
`uid` stands for "unique id", used on the client-side to save archive-specific settings.
The `uid` for a new archive should be an increment of the highest one,
make sure it does not overlap with an archive that previously died for example.
`software` can be `"foolfuuka"` or `"fuuka"` for example.
`files` is the list of boards whose files (images, videos, pdfs) are also archived, even temporarily, and not just thumbnails.