From 65ed699879f300d5ff1218d8ac34c436658d2196 Mon Sep 17 00:00:00 2001 From: maru21 Date: Sat, 24 Aug 2024 21:29:19 +0200 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e084b7..7fe00de 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ # pager.js -display texts on small displays \ No newline at end of file +## Description + +pager.js is a simple web application that utilizes the HTML5 `` element to display words from a given string one at a time. Users can control the speed of the word display and pause or resume the animation using a button. The application is designed to demonstrate the use of the canvas API and basic JavaScript functionalities. + +## Features + +- Displays words from a predefined string on an HTML5 canvas. +- Users can adjust the speed of word display using an input field. +- A pause/resume button allows users to control the animation. +- Responsive design with a clean and simple user interface. + +## Usage + +1. Open the application in your web browser. +2. The canvas will display the first word of the string. +3. Use the input field to adjust the speed of the word display (in milliseconds). +4. Click the "Pause" button to pause the word display. Click it again to resume. + +## Code Overview + +The main components of the project include: + +- **HTML Structure**: Contains a canvas element for displaying text, an input for speed control, and a button for pausing/resuming the display. +- **CSS Styles**: Styles for the body, canvas, button, and input to create a visually appealing layout. +- **JavaScript Logic**: Handles the word display logic, speed adjustment, and pause/resume functionality. + +## Contributing + +Contributions are welcome! If you have suggestions for improvements or new features, please fork the repository and submit a pull request. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.