Skip to content

Commit

Permalink
Merge pull request #6 from dev-ahmadbilal/develop
Browse files Browse the repository at this point in the history
Feat: add keywords and update readme doc
  • Loading branch information
dev-ahmadbilal authored Sep 2, 2024
2 parents 427cd5f + c7c1e26 commit 3ab9767
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ const date = '30-08-2024';
const latitude = 31.52037;
const longitude = 74.358749;

const prayerTimings = prayer.getPrayerTimesByLocation(date, latitude, longitude);
const prayerTimings = await prayer.getPrayerTimesByLocation(date, latitude, longitude);
console.log(prayerTimings);

//Output
Expand All @@ -369,7 +369,7 @@ import { Prayer } from 'islam.js';
const prayer = new Prayer();
const city = 'Dubai';
const country = 'United Arab Emirates';
const prayerTimings = prayer.getPrayerTimesByCity(city, country)
const prayerTimings = await prayer.getPrayerTimesByCity(city, country)
console.log(prayerTimings);

//Output
Expand All @@ -392,11 +392,11 @@ console.log(prayerTimings);
#### Get hijri calander date by location
```ts
import { HijriCalendar } from 'islam.js';
const calendar = new HijriCalendar();
const calender = new HijriCalendar();
const date = '30-08-2024';
const latitude = 31.52037;
const longitude = 74.358749;
const hijriDate = calander.getHijriDateByLocation(date, latitude, longitude)
const hijriDate = await calander.getHijriDateByLocation(date, latitude, longitude)
console.log(hijriDate);

//Output
Expand Down Expand Up @@ -424,10 +424,10 @@ console.log(hijriDate);
#### Get hijri calander date by city
```ts
import { HijriCalendar } from 'islam.js';
const calendar = new HijriCalendar();
const calender = new HijriCalendar();
const city = 'Dubai';
const country = 'United Arab Emirates';
const hijriDate = calander.getHijriDateByCity(city, country);
const hijriDate = await calander.getHijriDateByCity(city, country);
console.log(hijriDate);

//Output
Expand All @@ -452,6 +452,13 @@ console.log(hijriDate);
"holidays":[]
}
```
## Disclaimer

**islam.js** is an open-source package created to provide easy access to various Islamic resources such as Quran, Hadith, Dua, and Azkar. This package is not an authoritative source on Islam and should not be taken as a definitive representation of the religion.

I have made every effort to use authentic sources, but as with any human endeavor, there may be mistakes or inaccuracies. Users are encouraged to consult scholars or authentic religious sources for comprehensive understanding and verification.

By using this package, you acknowledge that it is provided as-is, and you agree to use it responsibly.

## License

Expand Down
21 changes: 20 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,26 @@
"quran",
"hadith",
"prayer",
"azkar"
"azkar",
"islamic-resources",
"tafseer",
"quran-api",
"hadith-api",
"dua",
"supplications",
"prayer-times",
"hijri-calendar",
"islamic-tools",
"muslim-developers",
"arabic-text",
"islamic-education",
"faith",
"spirituality",
"nodejs",
"typescript",
"javascript",
"npm-package",
"open-source"
],
"author": {
"name": "Ahmad Bilal",
Expand Down

0 comments on commit 3ab9767

Please sign in to comment.