diff --git a/README.md b/README.md index 9b35a09..a929432 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ -# The-Event-Horizon-App \ No newline at end of file +### The EventHorizon App + +--- + +#### Overview: +The EventHorizon App is a countdown timer application designed to help users anticipate and count down to significant events in their lives. Whether it's a predefined event like New Year's Eve or a custom event, such as a birthday or an anniversary, this app has you covered. + +#### Features: + +1. **Predefined Events:** Comes with a set of predefined events like New Year, Lunar New Year, and more. +2. **Custom Events:** Users can set their own events with a name and date. +3. **Automatic Event Update:** For some predefined events, once the date has passed, it automatically updates to the next year. +4. **Local Storage:** Remember the last event viewed, so when a user opens the app again, it displays the previously viewed event. +5. **Dynamic Backgrounds:** Alternates between different background images, providing a fresh look each time you open the app. +6. **Responsive Text Color:** Depending on the background, the text color adjusts for better readability. +7. **Inspiring Quotes:** Displays a random inspiring quote above the event title each time the app is loaded. +8. **About Page:** Provides more information about the app and its developer, with quick links to the developer's GitHub, LinkedIn, and Gmail. + +#### How to Use: + +1. **Selecting an Event:** Use the dropdown to select a predefined event or create a new custom event by entering its name and date. +2. **Deleting Custom Events:** Added an event by mistake? No worries, you can easily delete it from the custom events list. +3. **Check the Countdown:** Once an event is set or selected, the app will display a countdown timer, counting down days, hours, minutes, and seconds to the event. +4. **Know More:** Click on the 'About' button at the bottom to learn more about the app and the developer. + +#### Setup: + +1. **Clone the Repository:** Use `git clone https://github.com/hoangsonww/EventHorizon.git` to clone the repository. +2. **Open in Browser:** Navigate to the project directory and open the `index.html` in your favorite browser. +3. **Contribute:** Feel free to fork the repo and make your own changes. Pull requests are welcome! + +#### Credits: + +Developed by Son Nguyen Hoang. For feedback, collaboration, or inquiries, reach out through [GitHub](https://github.com/hoangsonww), [LinkedIn](https://www.linkedin.com/in/hoangsonw/), or [Gmail](mailto:hoangson091104@gmail.com). + +--- + +Stay inspired and keep looking forward to the horizon of events in your life! 🌅🕰️