Skip to content

Commit f857130

Browse files
committed
Update README to reflect new features and categories, including expanded question count and additional topics. Adjust repository clone URL for consistency.
1 parent 0f6ee05 commit f857130

1 file changed

Lines changed: 35 additions & 22 deletions

File tree

README.md

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
# JS Quiz Master
22

3-
A 100% open source, offline-first Progressive Web App (PWA) for testing your JavaScript knowledge. Focus on deep concepts like event loop, closures, async/await, this binding, type coercion, and prototypes.
3+
A 100% open source, offline-first Progressive Web App (PWA) for testing your JavaScript knowledge. Focus on deep concepts like event loop, closures, async/await, this binding, type coercion, prototypes, and more.
44

55
## Features
66

7-
- **Offline-First**: Works completely offline after first visit
8-
- **72+ Questions**: Covering 6 core JavaScript categories
9-
- **PWA Support**: Installable on mobile and desktop
10-
- **Statistics Tracking**: Track your progress and performance
11-
- **Share Results**: Share your quiz results with friends
12-
- **No Backend**: 100% client-side, no server required
13-
- **GitHub Pages Ready**: Deploy to GitHub Pages with one click
7+
- **Offline-First**: Works completely offline after first visit
8+
- **220+ Questions**: Covering 11 core JavaScript categories
9+
- **PWA Support**: Installable on mobile and desktop
10+
- **Statistics Tracking**: Track your progress and performance
11+
- **Share Results**: Share your quiz results with friends
12+
- **No Backend**: 100% client-side, no server required
13+
- **GitHub Pages Ready**: Deploy to GitHub Pages with one click
1414

1515
## Categories
1616

17-
- **Event Loop**: Understanding JavaScript event loop, call stack, and task queues
18-
- **Closures**: Lexical scoping, closure patterns, and memory management
19-
- **Async/Await**: Promises, async/await, and asynchronous programming
20-
- **This Binding**: Context binding, arrow functions, and method invocation
21-
- **Type Coercion**: Type conversion, truthy/falsy values, and implicit conversions
22-
- **Prototypes**: Prototype chain, inheritance, and object-oriented patterns
17+
| Category | Description |
18+
|----------|-------------|
19+
| **Event Loop** | Understanding JavaScript event loop, call stack, and task queues |
20+
| **Closures** | Lexical scoping, closure patterns, and memory management |
21+
| **Async/Await** | Promises, async/await, and asynchronous programming |
22+
| **This Binding** | Context binding, arrow functions, and method invocation |
23+
| **Type Coercion** | Type conversion, truthy/falsy values, and implicit conversions |
24+
| **Prototypes** | Prototype chain, inheritance, and object-oriented patterns |
25+
| **Hoisting** | Variable and function hoisting, temporal dead zone |
26+
| **Scope** | Block, function, and global scope, scope chain |
27+
| **Destructuring** | Object and array destructuring, rest/spread patterns |
28+
| **Arrays** | Array methods, iteration, and common gotchas |
29+
| **Objects** | Object manipulation, property descriptors, and edge cases |
2330

2431
## Getting Started
2532

@@ -32,7 +39,7 @@ A 100% open source, offline-first Progressive Web App (PWA) for testing your Jav
3239

3340
```bash
3441
# Clone the repository
35-
git clone https://github.com/yourusername/js-quizzy.git
42+
git clone https://github.com/xseman/js-quizzy.git
3643

3744
# Install dependencies
3845
npm install
@@ -67,26 +74,32 @@ npm run generate-questions
6774
```
6875
js-quizzy/
6976
├── app/ # Next.js App Router pages
70-
├── components/ # React components
71-
├── lib/ # Core logic and utilities
72-
├── public/ # Static assets and questions
73-
│ ├── questions/ # Question JSON files
74-
│ └── sw.js # Service Worker
75-
├── scripts/ # Build and validation scripts
76-
└── docs/ # Documentation
77+
├── components/ # React components
78+
├── lib/ # Core logic and utilities
79+
├── public/ # Static assets and questions
80+
│ ├── questions/ # Question JSON files
81+
│ └── sw.js # Service Worker
82+
├── scripts/ # Build and validation scripts
83+
└── docs/ # Documentation
7784
```
7885

7986
## Adding Questions
8087

8188
See [CONTRIBUTING.md](./docs/CONTRIBUTING.md) for guidelines on adding questions.
8289

8390
Questions are stored in JSON files in `public/questions/`. Each category has its own file:
91+
8492
- `event-loop.json`
8593
- `closures.json`
8694
- `async.json`
8795
- `this.json`
8896
- `coercion.json`
8997
- `prototypes.json`
98+
- `hoisting.json`
99+
- `scope.json`
100+
- `destructuring.json`
101+
- `arrays.json`
102+
- `objects.json`
90103

91104
## Deployment
92105

0 commit comments

Comments
 (0)