📚Updated README with v0.3 features (#191)+:paintbrush:Added question …

…style guide (#191)+:page_facing_up:Added scripts to README (#192)
Rllyyy · Oct 16, 2022 · 5a3201e · 5a3201e
1 parent 740cb83
commit 5a3201e
Show file tree

Hide file tree

Showing 19 changed files with 546 additions and 76 deletions.
diff --git a/.github/Docs/assets/images/blue-text.png b/.github/Docs/assets/images/blue-text.png
diff --git a/.github/Docs/assets/images/bookmark-question.png b/.github/Docs/assets/images/bookmark-question.png
diff --git a/.github/Docs/assets/images/delete-bookmarked-questions.png b/.github/Docs/assets/images/delete-bookmarked-questions.png
diff --git a/.github/Docs/assets/images/delete-question.png b/.github/Docs/assets/images/delete-question.png
diff --git a/.github/Docs/assets/images/edit-question.png b/.github/Docs/assets/images/edit-question.png
diff --git a/.github/Docs/assets/images/example-extended-match.png b/.github/Docs/assets/images/example-extended-match.png
diff --git a/.github/Docs/assets/images/example-gap-text-dropdown.png b/.github/Docs/assets/images/example-gap-text-dropdown.png
diff --git a/.github/Docs/assets/images/example-gap-text.png b/.github/Docs/assets/images/example-gap-text.png
diff --git a/.github/Docs/assets/images/example-multiple-choice.png b/.github/Docs/assets/images/example-multiple-choice.png
diff --git a/.github/Docs/assets/images/example-multiple-response.png b/.github/Docs/assets/images/example-multiple-response.png
diff --git a/.github/Docs/assets/images/export-bookmarked-questions.png b/.github/Docs/assets/images/export-bookmarked-questions.png
diff --git a/.github/Docs/assets/images/import-bookmarked-questions.png b/.github/Docs/assets/images/import-bookmarked-questions.png
diff --git a/.github/Docs/assets/images/practice-chronological.png b/.github/Docs/assets/images/practice-chronological.png
diff --git a/.github/Docs/assets/images/practice-random.png b/.github/Docs/assets/images/practice-random.png
diff --git a/.github/Docs/assets/images/train-bookmarked-questions.png b/.github/Docs/assets/images/train-bookmarked-questions.png
diff --git a/.github/Docs/assets/images/unbookmark-question.png b/.github/Docs/assets/images/unbookmark-question.png
diff --git a/.github/Docs/module-file-structure.md b/.github/Docs/module-file-structure.md
@@ -0,0 +1,20 @@
+# Module file structure
+
+This file documents the structure of a module inside the localStorage. If you are a normal user of repeatio you don't need to worry about this.
+
+```json
+{
+  "id": "MOD01",
+  "name": "Module Name",
+  "lang": "en",
+  "compatibility": "0.3.0",
+  "questions": [
+    {
+      "id": "MOD01-1",
+      "...": "..."
+    }
+  ]
+}
+```
+
+**_[View File Example](../../public/data.json)_** and **[interactive result](https://repeatio.netlify.app/module/types_1/all-questions)**