Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mamantoha committed Apr 29, 2024
1 parent 6ccba5f commit a5a22e2
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ Calculate the approximate area of the polygon were it projected onto the earth.

## Usage

Calling `RingArea.ring_area` returns a `RingArea::Area` object which can provide output in kilometers, meters, miles, feet, etc.

```crystal
require "ring_area"
Expand All @@ -41,7 +39,7 @@ RingArea.ring_area(coordinates).to_meters
```
Accepts an `Array(Array(Number))` of Ring Coordinates as `[[longitude1, latitude1], [longitude2, latitude2], ...]`.

Returns the approximate signed geodesic area of the polygon in square meters.
Returns a `RingArea::Area` object which can provide output in kilometers, meters, miles, feet, etc.

## Contributing

Expand Down

0 comments on commit a5a22e2

Please sign in to comment.