From 53cff2516ddab186b97c4b1ccfaf75f42cc6f7d9 Mon Sep 17 00:00:00 2001
From: Mayhem <stepien.nicolas@gmail.com>
Date: Thu, 11 Sep 2014 03:56:26 +0200
Subject: [PATCH] Create CONTRIBUTING.md

---
 CONTRIBUTING.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..7b7d4445b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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.