Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danikova authored Dec 5, 2023
1 parent cebc9e2 commit 9d8a655
Showing 1 changed file with 42 additions and 4 deletions.
46 changes: 42 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,43 @@
### Some examples
# Event Horizon

?endDate=20231231T235900%2B01%3A00&digits=d%2Ch%2Cm%2Cs&title=Samu+cicca&imageId=KcQL9aE.jpg
?endDate=20231201T170000%2B01%3A00&digits=d%2Ch%2Cm%2Cs&title=Eredményhirdetés&imageId=0ypIMfs.jpg
?endDate=20240408T100000%2B01%3A00&digits=d%2Ch%2Cm%2Cs&title=Nassfeld+2024&imageId=rmfyUHg.jpg
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![GitHub issues](https://img.shields.io/github/issues/danikova/event-horizon)](https://github.com/danikova/event-horizon/issues)
[![GitHub stars](https://img.shields.io/github/stars/danikova/event-horizon)](https://github.com/danikova/event-horizon/stargazers)

Event Horizon is a straightforward and user-friendly countdown timer designed for simplicity and ease of use. With the ability to configure the timer using query parameters, users can effortlessly create personalized countdowns without the need for a database. This feature enables seamless sharing of configured timers through a simple copy-and-paste mechanism.

## Features

- **Customizable Title**: Personalize your timer by setting a unique title that reflects the event or countdown purpose.

- **End Date Configuration**: Easily set the end date for your countdown, allowing you to precisely time your event or deadline.

- **Digit Selection**: Choose which digits to display on the webpage, giving you control over the information presented.

- **Blurred Background Image**: Enhance the visual appeal of your timer with a dynamically blurred background picture fetched from Imgur.

- **Elapsed and Remaining Time Display**: Stay informed with both elapsed and remaining time measures, ensuring you have a comprehensive view of the countdown progress.

- **Theming Options**: Tailor the timer to your preference with light, dark, or automatic theming, providing a visually pleasing experience in any environment.

- **Dominant Color Theming**: Immerse yourself in a cohesive design by having the main text colored with the dominant color extracted from the background image.

- **PWA (Progressive Web App) Support**: Enjoy the benefits of a Progressive Web App, allowing users to install and use the timer seamlessly as if it were a native app.

## Getting Started

```bash
npm install
npm start
```

## Examples

- [A cute cat](https://danikova.github.io/event-horizon/?endDate=20231231T235900%2B01%3A00&digits=d%2Ch%2Cm%2Cs&title=Samu&imageId=KcQL9aE.jpg)
- [Announcement of results](https://danikova.github.io/event-horizon/?endDate=20231201T170000%2B01%3A00&digits=d%2Ch%2Cm%2Cs&title=Results+announced&imageId=0ypIMfs.jpg)
- [Ski trip](https://danikova.github.io/event-horizon/?endDate=20240408T100000%2B01%3A00&digits=d%2Ch%2Cm%2Cs&title=Ski+trip+2024&imageId=rmfyUHg.jpg)

## License
This project is licensed under the MIT License - see the LICENSE.md file for details.

Enjoy using Event Horizon for all your countdown needs!

0 comments on commit 9d8a655

Please sign in to comment.