From b69760fe7bed7a2f01b889f090efd933d57fa1cf Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Thu, 15 Mar 2018 16:59:10 -0400 Subject: [PATCH] Move index to README No more symlinks --- README.md | 21 ++++++++++++++++++++- index.md | 20 -------------------- 2 files changed, 20 insertions(+), 21 deletions(-) mode change 120000 => 100644 README.md delete mode 100644 index.md diff --git a/README.md b/README.md deleted file mode 120000 index dd0ea36..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -index.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..113b3c6 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Pelias Documentation + +Here is where you can find all documentation for the [Pelias geocoder](https://github.com/pelias/pelias/). + +## Table of Contents + +### Core Features and API Documentation +- [Forward geocoding](search.md) to find a place by searching for an address or name +- [Reverse geocoding](reverse.md) to find what is located at a certain coordinate location +- [Autocomplete](autocomplete.md) to give real-time result suggestions without having to type the whole location +- [Global coverage with prioritized local results](search.md#prioritize-results-by-proximity) +- [Structured Geocoding](structured-geocoding.md) to find a place with data already separated into housenumber, street, city, etc +- [Glossary of common terms](glossary.md) + +### Data Sources +- [Pelias data sources](data-sources.md) +- [Tools for embedding search](https://mapzen.com/documentation/mapzen-js/search/) in a map + +### Running your own Pelias +- [Pelias installation guide](https://github.com/pelias/pelias/blob/master/INSTALL.md) diff --git a/index.md b/index.md deleted file mode 100644 index 113b3c6..0000000 --- a/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# Pelias Documentation - -Here is where you can find all documentation for the [Pelias geocoder](https://github.com/pelias/pelias/). - -## Table of Contents - -### Core Features and API Documentation -- [Forward geocoding](search.md) to find a place by searching for an address or name -- [Reverse geocoding](reverse.md) to find what is located at a certain coordinate location -- [Autocomplete](autocomplete.md) to give real-time result suggestions without having to type the whole location -- [Global coverage with prioritized local results](search.md#prioritize-results-by-proximity) -- [Structured Geocoding](structured-geocoding.md) to find a place with data already separated into housenumber, street, city, etc -- [Glossary of common terms](glossary.md) - -### Data Sources -- [Pelias data sources](data-sources.md) -- [Tools for embedding search](https://mapzen.com/documentation/mapzen-js/search/) in a map - -### Running your own Pelias -- [Pelias installation guide](https://github.com/pelias/pelias/blob/master/INSTALL.md)