diff --git a/README.md b/README.md new file mode 100644 index 0000000..adcc3e7 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Typographic Clock + +![Typographic Clock](clock_demo.gif) + +This is a typographic clock created using HTML, CSS, and JavaScript. It displays the current time by moving a redish-colored segment over each number, providing a unique and visually appealing way of showing time. The clock comes with both dark and light modes for different preferences. + +## Features + +- Real-time display of the current time. +- Smooth animation of the seconds segment. +- Dark mode and light mode options for different appearances. + +## Demo + +Check out the live demo: [Typographic Clock Demo]([https://your-demo-link-here.com](https://hi-aman-jain.github.io/Typographic-Clock/)) + +## Screenshots + +![Dark Mode](screenshots/dark_mode.png) +![Light Mode](screenshots/light_mode.png) + +## Installation + +1. Clone the repository: `git clone [[Your GitHub Repository Link](https://github.com/Hi-Aman-Jain/Typographic-Clock.git)]` +2. Navigate to the project directory: `cd [Typographic-Clock]` + +## Usage + +1. Open `index.html` in your web browser. +2. The clock will automatically start displaying the current time with the moving seconds segment. + +## Dark Mode and Light Mode + +The clock comes with two modes: + +### Dark Mode + +To enable dark mode, follow these steps: + +1. Open `index.html` in your web browser. +2. Click the "Dark Mode" button to switch to the dark theme. + +### Light Mode + +To switch back to light mode: + +1. Open `index.html` in your web browser. +2. Click the "Light Mode" button to switch to the light theme. + +## Contributing + +Contributions are welcome! Feel free to open an issue or submit a pull request for any improvements or fixes. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.