Skip to content

Commit 9c54671

Browse files
committed
updated Readme
:
1 parent 32f48f0 commit 9c54671

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
# javascriptCodeQuiz
1+
# Abe's Javascript Code Quiz
2+
3+
[This Javascript Code Quiz](https://aomaits.github.io/javascriptCodeQuiz) is a quiz over a few fundamental Javascript topics.
4+
5+
There are currently only 3 questions. Future versions could have more questions, increased design flexibility, and the option to store multiple user's scores.
6+
7+
![Quiz Screen](/assets/quizScreen.jpg "Snip of the quiz screen")
8+
![Score Screen](/assets/scoreScreen.jpg "Snip of the score screen")
9+
10+
## How It Works
11+
The webpage opens on a greeting screen. Users can click a button to start the quiz. Along with the quiz, a timer also begins. Questions are then rendered to the user's browser dynamically using Javascript. After either time runs out or the user has progressed through all of the questions, the user is shown their final score. The final score is calculated by adding the total correct answers to the time remaining. Users receive one point for all correct answers, are docked one point for incorrect answers, and receive an additional point for every 5 seconds remaining on the clock. For example, completing the quiz with 10 seconds left and only one of the three answers correct, our user will receive a final score of 1.
12+
13+
A final score can then be saved by the user along with their initials and can be accessed later. From the high scores screen, users can navigate back to the start of the quiz.
14+
15+
## Usage
16+
This quiz is intended for practicing basic Javascript principles.
17+
18+
## Credits
19+
N/A
20+
21+
## License
22+
This repository uses a standard [MIT License.](https://github.com/aomaits/javascriptCodeQuiz/blob/main/LICENSE)

assets/quizScreen.jpg

31.1 KB
Loading

assets/scoreScreen.jpg

17.8 KB
Loading

0 commit comments

Comments
 (0)