Borys35/reading-test

Reading Test is a web platform where you can check and increase your reading speed. You can choose multiple languages and options.

Reading Test

Reading Test is a web platform where you can check and increase your reading speed. You can choose multiple languages and options.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

(back to top)

Built With

• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Borys35/reading-test.git

2. Install NPM packages

   npm install

(back to top)

Contributing

You can add new languages and texts in src/languages.ts file!

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Borys Kaczmarek - boryskac10@gmail.com

Project Link: https://github.com/Borys35/reading-test

(back to top)

Acknowledgments

• Best-README-Template

(back to top)