Skip to content

Commit

Permalink
upload readme
Browse files Browse the repository at this point in the history
  • Loading branch information
toddehalexander authored Dec 18, 2023
1 parent d65e11c commit e45de78
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# CodeRacer

CodeRacer is a web-based game designed for programmers who enjoy improving their typing speed and accuracy while learning about popular programming algorithms. Track your progress, customize your experience, and compete on the leaderboard to become the ultimate Code Racer.

## Introduction

The goal of CodeRacer is to provide programmers with a way to continuously improve their typing speed and accuracy while also introducing them to various algorithms. As users become more proficient in typing, they'll be exposed to more efficient and interesting algorithms, further expanding their programming knowledge. With real-time leaderboards and customizable profiles, CodeRacer offers an exciting and memorable experience for those looking to improve their typing skills and programming expertise.

## Features

- Typing challenges based on popular programming algorithms
- Real-time statistics: Total Words Typed, Total Characters Typed, Average WPM, Average CPM, Accuracy, Lifetime Accuracy, Total Completed Runs, Total Time Spent Typing
- Customizable user experience with themes
- Educational resources for learning about algorithms
- Real-time leaderboard for friendly competition

## Getting Started

Visit the CodeRacer website at [https://toddehalexander.github.io/CodeRacer/](https://toddehalexander.github.io/CodeRacer/) to start playing and improving your typing skills.

## Usage

1. Create an account or sign in to track your progress and customize your profile.
2. Choose your preferred programming language to start typing.
3. Upon completing the challenge, view your typing statistics and compare them to your previous scores.
4. Learn more about the algorithm by following the provided educational resource link.
5. Climb the leaderboard and compete with other users.

## License

CodeRacer is released under the MIT License.

0 comments on commit e45de78

Please sign in to comment.