Skip to content
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.

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

Update README.md #69

Merged
merged 1 commit into from
May 13, 2024
Merged
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ val prayerTimes = PrayerTimes(coordinates, dateComponents, parameters)
Create a `Coordinates` object with the latitude and longitude for the location you want prayer times for.

```kotlin
val coordinates = Coordinates(35.78056, -78.6389);
val coordinates = Coordinates(35.78056, -78.6389)
```

#### Date

The date parameter passed in should be an instance of the `DateComponents` object. The year, month, and day values need to be populated. All other values will be ignored. The year, month and day values should be for the local date that you want prayer times for. These date values are expected to be for the Gregorian calendar. There's also a convenience method for converting a `java.util.Date` to `DateComponents`.

```kotlin
val date = DateComponents(2015, 11, 1);
val date = DateComponents(2015, 11, 1)
```

#### Calculation parameters
Expand Down Expand Up @@ -113,8 +113,8 @@ formatter.format(Date(prayerTimes.fajr.toEpochMilliseconds()))
As of version 1.1.0, this library provides a `Qibla` class for getting the qibla for a given location.

```kotlin
val coordinates = Coordinates(latitude, longitude);
val qibla = Qibla(coordinates);
val coordinates = Coordinates(latitude, longitude)
val qibla = Qibla(coordinates)
// qibla.direction is the qibla direction
```

Expand All @@ -123,7 +123,7 @@ val qibla = Qibla(coordinates);
The library provides a `SunnahTimes` class.

```kotlin
val sunnahTimes = SunnahTimes(prayerTimes);
val sunnahTimes = SunnahTimes(prayerTimes)
// sunnahTimes.middleOfTheNight is the midpoint between Maghrib and Fajr
// sunnahTimes.lastThirdOfTheNight is the last third between Maghrib and Fajr
```
Expand Down
Loading