Create README.md

README.md

@@ -0,0 +1,61 @@
+# Namaz Timings - نماز اوقات
+
+<img src="https://play-lh.googleusercontent.com/fgDJ6OGzBYfCEgETV-eS94jbWhp-1ch9XEbi2-TCQNb9vBwWh1XsFdkvhu56HSuiaQ=w240-h480-rw" alt="App Logo" width="200">
+
+Namaz Timings App is an open-source application that provides accurate prayer times with a unique pixelated (minimal) look inspired by wall clocks in mosques. It utilizes the Adhan library to calculate and display prayer times accurately.
+
+## Features
+
+- Accurate prayer times calculation.
+- Minimalistic and pixelated design inspired by mosque wall clocks.
+- Supports multiple locations and timezones.
+- Notifications for prayer times.
+- Customizable notification sound and volume.
+- Dark and light mode support.
+- Offline support for previously fetched prayer times.
+- Easy-to-use and user-friendly interface.
+
+## Screenshots
+
+![Screenshot 1](https://play-lh.googleusercontent.com/j6ILPy3aMXc7HT5ZK5HJL5SX8hs_Wc9k7K_KmECdmNdMZHvPtl9V9uW7yaAiIhPv7Lw=w526-h296-rw)
+![Screenshot 2](https://play-lh.googleusercontent.com/TaJ-7l-oFj6Uk4_aiZY7JwApfZtoJD9m2AUYf7nZ18hkNnVqbLGG8ZkZSoBN50F8ikE=w526-h296-rw)
+
+## Installation
+
+1. Clone the repository to your local machine:
+git clone https://github.com/yourusername/namaz-timings-app.git
+2. Install the required dependencies:npm install
+3. Start the application: npm start
+
+
+## Usage
+
+1. Launch the app.
+2. Set your location and timezone.
+3. Customize notification settings if desired.
+4. The app will display the prayer times for the current day.
+
+## Contributions
+
+Contributions are welcome! If you would like to contribute to this project, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`
+3. Make your changes and commit them: `git commit -m 'Add feature/fix bug'`
+4. Push to your branch: `git push origin feature/your-feature-name`
+5. Create a pull request to the `main` branch of the original repository.
+
+Please make sure your code follows the project's coding standards and includes appropriate documentation.
+
+## Credits
+
+This project relies on the [Adhan library](https://github.com/batoulapps/Adhan) for prayer times calculation.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Enjoy using the Namaz Timings App! If you have any questions or encounter issues, please feel free to open an issue on GitHub.
+