Skip to content

Update README.md to have a known issues section #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gheidrich25 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md to have a known issues section #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The goal of the UF Alarm Clock project is to create an alarm clock that not only
- [UF Alarm Clock](#uf-alarm-clock)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Known Issues](#known-issues)
- [Contributing](#contributing)
- [Resources](#resources)
- [Maintainers](#maintainers)
Expand Down Expand Up @@ -93,6 +94,22 @@ Run server
go1.23.1 run ./main.go
```

## Known Issues

**1. Alarm Notifications Persist After Deletion**

Description: Alarm notifications continue to appear even after the alarm has been turned off or deleted. Additionally, the notification time may be inaccurate, differing by an hour from the set time compared to the device's local time.

Workaround: Currently, there is no direct workaround. Users may need to restart the application to stop the unwanted notifications.

Reference: [Issue #74](https://github.com/ufosc/Alarm-Clock/issues/74)

**2. (similar) Alarms Continue After Server Shutdown**

Description: Alarms set within the app continue to notify the user even when the local development server is not running.

Workaround: To disable these alarms, restart the local development server and remove the alarms from within the app.

## 🤝 Contributing

To contribute to this repository, please follow the following steps:
Expand Down