diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d21db8 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# NHL Scoreboard Web App + +This web application displays live NHL game scores, team statistics, and game states in real-time. It retrieves data from the NHL API and presents it in a user-friendly interface. + +## Features + +- Displays live NHL game scores. +- Sorts games based on priority to highlight the most exciting matchups. +- Responsive design for desktop and mobile devices. + +## Technologies Used + +- **Python**: Backend scripting language. +- **Flask**: Web framework for Python. +- **HTML/CSS**: Frontend markup and styling. +- **JavaScript**: Client-side scripting for auto-refresh functionality. + +## Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/your-username/nhl-scoreboard.git + ``` + +2. Install dependencies: + + ```bash + pip install -r requirements.txt + ``` + +3. Run the application: + + ```bash + python app.py + ``` + +4. Open your web browser and navigate to `http://localhost:2897` to view the scoreboard. + +## Usage + +- The scoreboard will display live NHL game scores, team statistics, and game states. +- Games are sorted based on priority to highlight the most exciting matchups. +- The page updates automatically every 10 seconds to show the latest data. +- Responsive design ensures a seamless experience on desktop and mobile devices. + +## Credits + +Special thanks to the NHL for providing the data through their API. + +## License + +This project is licensed under the [MIT License](LICENSE).