Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mjaschen committed Mar 29, 2016
1 parent a9f80b4 commit aac1c10
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ phpgeo provides abstractions to geographical coordinates (including support for
- [Requirements](#requirements)
- [Documentation](#documentation)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Distance between two coordinates (Vincenty's Formula)](#distance-between-two-coordinates-vincentys-formula)
- [Features](#features)
- [Examples/Usage](#examplesusage)
- [Distance between two coordinates \(Vincenty's Formula\)](#distance-between-two-coordinates-vincentys-formula)
- [Simplifying a polyline](#simplifying-a-polyline)
- [Polygon contains a point (e.g. "GPS geofence")](#polygon-contains-a-point-eg-gps-geofence)
- [Polygon contains a point \(e.g. "GPS geofence"\)](#polygon-contains-a-point-eg-gps-geofence)
- [Formatted output of coordinates](#formatted-output-of-coordinates)
- [Decimal Degrees](#decimal-degrees)
- [Degrees/Minutes/Seconds (DMS)](#degreesminutesseconds-dms)
- [Degrees/Minutes/Seconds \(DMS\)](#degreesminutesseconds-dms)
- [GeoJSON](#geojson)
- [Credits](#credits)

Expand All @@ -38,7 +38,7 @@ Using [Composer](https://getcomposer.org), just add it to your `composer.json` b
composer require mjaschen/phpgeo
```

## Usage
## Features

**Info:** Please visit the [documentation site](https://phpgeo.marcusjaschen.de/) for complete and up-to-date documentation!

Expand All @@ -59,12 +59,13 @@ phpgeo provides the following features (follow the links for examples):
(spherical or with Vincenty's formula)
- calculation of a [destination point for a given starting point](https://phpgeo.marcusjaschen.de/calculations/bearing/#destination-point-for-given-bearing-and-distance),
bearing angle, and distance (spherical or with Vincenty's formula)
- calculation of the [perpendicular distance between a point and a line](https://phpgeo.marcusjaschen.de/#_perpendicular_distance)
- getting segments of a [polyline](https://phpgeo.marcusjaschen.de/geometry/polyline/#segments)
/[polygon](https://phpgeo.marcusjaschen.de/geometry/polygon/#segments),
- [reversing direction](https://phpgeo.marcusjaschen.de/geometry/polyline/#reverse-direction)
of polyline/polygon

## Examples
## Examples/Usage

This list is incomplete, please visit the [documentation site](https://phpgeo.marcusjaschen.de/)
for the full monty of documentation and examples!
Expand Down

0 comments on commit aac1c10

Please sign in to comment.