Add readme

vivekkj123 · Aug 27, 2021 · 86c1d3d · 86c1d3d
1 parent 628c161
commit 86c1d3d
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,45 @@
+# quizApp ❓
+Customisable quizApp made in react native
+
+## Features ⚛️
+
+- Customisable Questions
+
+## Screenshots 🖼️
+
+![](doc/screen1.jpg)
+![](doc/screen2.jpg)
+![](doc/screen3.jpg)
+
+
+## Questions.json ❔
+
+```
+{
+questions:[
+     { 
+        question: "Example Question",
+        answers: ["Option 1","Option 2","Option 3", "Option 4"], // 4 options
+        correctIndex: 2 // Index of the correct option 
+    }
+]
+}
+```
+
+
+## How to build? 🏗️
+
+https://reactnative.dev/docs/signed-apk-android
+
+## Contributing/ Future of this project 🧭
+
+Well, this project is one of my side projects. If anyone interested in making it better you're always welcome 🤗
+
+## Things I learned by doing this project
+
+- Global state management in React native using redux and context
+- Practical example of stack navigator
+- Screen navigation
+## Anything more?
+
+If you liked my work, consider staring the repository and spread the word. ⭐️
diff --git a/doc/screen1.jpg b/doc/screen1.jpg
diff --git a/doc/screen2.jpg b/doc/screen2.jpg
diff --git a/doc/screen3.jpg b/doc/screen3.jpg