diff --git a/README.md b/README.md index e69de29..590a35f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,29 @@ +# Prayer Times App + +A simple app to get Islamic prayer times by city and country using the [Aladhan API](https://aladhan.com/prayer-times-api). + +## Tech +- **HTML**: `index.pug` → `index.html` +- **CSS**: `style.sass` → `style.css` +- **JS**: Vanilla JS with `async/await` +- **Tools**: Pug, Sass, npm scripts + +___ + +## Features +- Search prayer times by **city** and **country** +- Toggle to show **5 main prayers** or **all prayer times** +- Clean, modern UI with mobile-friendly design +- Auto-focus and instant feedback +- Built with **Pug**, **Sass**, and vanilla **JavaScript** + +___ + +## How to Run +Just Click [**On This Link**](https://github.com/MuhammadFarouk12/prayingApi/deployments/github-pages) +___ + +## Notes +- `app.commented.js` is a fully documented version of the logic — great for learning or future reference. +- The app uses async/await with try/catch for safe API error handling. +- Focus management improves user experience on mobile.