Skip to content

Commit

Permalink
updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael committed May 29, 2017
1 parent 65bba12 commit 9761e7f
Showing 1 changed file with 76 additions and 16 deletions.
92 changes: 76 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,56 +10,116 @@ my $webAgent = API::NavalObservatory.new( apiID => "MyID" );

## Methods

### Day and Night Across the Earth - Cylindrical Projection
#### EXAMPLE:
#### Return:

#### Day and Night Across the Earth - Cylindrical Projection
### Day and Night Across the Earth - Spherical Projection
#### EXAMPLE:
#### Return:

#### Day and Night Across the Earth - Spherical Projection

#### Day and Night Across the Earth - Cylindrical Projectio
### Day and Night Across the Earth - Cylindrical Projection
#### EXAMPLE:
#### Return:

### Day and Night Across the Earth - Spherical Projections
#### EXAMPLE:
#### Return:
This method returns a JSON formatted text blob.

### Apparent Disk of a Solar System Object
#### EXAMPLE:
#### Return:
This method returns a JSON formatted text blob.

### Phases of the Moon
#### EXAMPLE:
#### Return:
This method returns a JSON formatted text blob.

#### Apparent Disk of a Solar System Object
### Complete Sun and Moon Data for One Day
#### EXAMPLE:
#### Return:
This method returns a JSON formatted text blob.

#### Phases of the Moon
### Sidereal Time
#### EXAMPLE:
#### Return:
This method returns a JSON formatted text blob.

### Solar Eclipse Calculator
This data service provides local circumstances for solar eclipses, and also provides a means for determining dates and types of eclipses in a given year.

#### EXAMPLE:
The following example shows a request using a U.S. based location.

```
my $request = $webAgent.solarEclipses(
:loc("San Francisco, CA"),
:dateTimeObj($dateTimeData),
:height(50),
:format("json") );
```
The following example shows a request using lat and long.

#### Complete Sun and Moon Data for One Day
```
my $request = $webAgent.solarEclipses(
:loc("San Francisco, CA"),
:dateTimeObj($dateTimeData),
:height(50),
:format("json") );
```

#### Sidereal Time
#### Return:
This method returns a JSON formatted text blob.

#### Solar Eclipse Calculator
### Selected Christian Observances
This data service provides the dates of Ash Wednesday, Palm Sunday, Good Friday, Easter, Ascension Day, Whit Sunday, Trinity Sunday, and the First Sunday of Advent in a given year. Data will be provided for the years 1583 through 9999. More information about this application may be found here

#### Selected Christian Observances
#### EXAMPLE:
`my $request = $webAgent.observancesChristan( :year(2017) );`
#### Return:
This method returns a JSON formatted text blob.

#### Selected Jewish Observances
### Selected Jewish Observances
This data service provides the dates for Rosh Hashanah (Jewish New Year), Yom Kippur (Day of Atonement), first day of Succoth (Feast of Tabernacles), Hanukkah (Festival of Lights), first day of Pesach (Passover), and Shavuot (Feast of Weeks) in a given year. Data will be provided for the years 360 C.E. (A.M. 4120) through 9999 C.E. (A.M. 13761).

#### EXAMPLE:
`my $request = $webAgent.observancesJewish( :year(2017) );`
#### Return:
This method returns a JSON formatted text blob.

#### Selected Islamic Observances
### Selected Islamic Observances
This data service provides the dates for Islamic New Year, the first day of Ramadân, and the first day of Shawwál in a given year.

The `.observancesIslamic` method takes one argument called year, which should be a unsigned integer in the range of 622 to 9999.

##### EXAMPLE:
#### EXAMPLE:
`my $request = $webAgent.observancesIslamic( :year(2017) );`

#### Julian Date Converter
#### Return:
This method returns a JSON formatted text blob.


### Julian Date Converter
This data service converts dates between the Julian/Gregorian calendar and Julian date. Data will be provided for the years 4713 B.C. through A.D. 9999, or Julian dates of 0 through 5373484.5. More information about this application may be found here.

To use the `.julianDate` method, you must provide a valid `DateTime` object and a valid Era OR an unsigned integer.

This method returns a JSON text blob of the request converted into ether a Julian or calendar date.


##### EXAMPLES:
#### EXAMPLES:

`my $request = $webAgent.julianDate( 2457892.312674 );`

`my $request = $webAgent.julianDate( DateTime.now, 'AD');`
##### Return:
#### Return:
This method returns a JSON formatted text blob.




## Returns
* For services which return text, you will receive an JSON formatted blob of text.
* For services which produce a image, this API will save the .PNG file in the current working directory.
Expand Down

0 comments on commit 9761e7f

Please sign in to comment.