Files
athan/README.md
T

47 lines
1.3 KiB
Markdown

# Athan
Location-Aware Prayer Schedule, Countdown, 24-Hour Timeline & Live Alarm Engine for Gravitiny.
Author: **Hamza Tariq** (`hamzatariq`)
---
## Features
- **Geolocation & AlAdhan API:** Auto-detects local city/country or accepts manual coordinates, querying official calculation methods (Diyanet, MWL, ISNA, Karachi).
- **Daily Prayer Table:** Beautifully formatted schedule table with Hijri date and active prayer window indicator.
- **Next Prayer Countdown:** Displays exact hours, minutes, and seconds remaining.
- **24-Hour Timeline Chart:** Visual ASCII timeline chart depicting the entire day's progression with a live current-time indicator.
- **Live Monitor & Acoustic Alarm:** Interactive terminal dashboard that plays an alert when the prayer time arrives. Press `q` or `ESC` to exit.
- **Offline Calculation Engine:** Falls back to astronomical solar math when internet is offline.
---
## Usage
```bash
# View today's prayer schedule table
athan
# View countdown to next prayer
athan next
# View 24-hour visual timeline chart
athan timeline
# Start live interactive monitor and alarm
athan live
# Configure manual city/country
athan config --city Istanbul --country Turkey --method 13
# Reset to auto-geolocation
athan config --auto
```
---
## License
MIT License.