\n\nWhat is Pelias?\n \nPelias is a search engine for places worldwide, powered by open data. It turns addresses and place names into geographic coordinates, and turns geographic coordinates into places and addresses. With Pelias, you're able to turn your users' place searches into actionable geodata and transform your geodata into real places.\n
\nWe think open data, open source, and open strategy win over proprietary solutions at any part of the stack and we want to ensure the services we offer are in line with that vision. We believe that an open geocoder improves over the long-term only if the community can incorporate truly representative local knowledge.\n\n\n# Pelias Labels\n\n\n\n## Overview\n\nModule that generates labels for Pelias search and geocoding results\n\n## Installation\n\n```bash\n$ npm install pelias-labels\n```\n\n## NPM Module\n\nThe `pelias-labels` npm module can be found here:\n\n[https://npmjs.org/package/pelias-labels](https://npmjs.org/package/pelias-labels)\n\n#### About\n\nThe Pelias Labels module is intended to be used a post-processing step that generates a rules-based label for Pelias search and geocoding results. There are generic label assembly rules for all but the [United Kingdom](https://whosonfirst.mapzen.com/spelunker/id/85633159/#4/55.76/-5.96), the [United States](https://whosonfirst.mapzen.com/spelunker/id/85633793/#2/52.3/0.3), [Australia](https://whosonfirst.mapzen.com/spelunker/id/85632793/#3/-27.80/136.02), and [Canada](https://whosonfirst.mapzen.com/spelunker/id/85633041/#2/71.3/-96.8), which have specific rules. \n\n#### Examples\n\nThe first example is for an address in New York City. \n\n```\n{\n name: '30 West 26th Street',\n house_number: '30',\n street: 'West 26th Street',\n borough: 'Manhattan',\n locality: 'New York City',\n county: 'New York County',\n region: 'New York',\n region_a: 'NY',\n country: 'United States',\n country_a: 'USA'\n}\n```\n\nThe label uses the name, borough, locality, region, and country, resulting in: `30 West 26th Street, Manhattan, New York City, NY, USA`\n\nThis next example is for a city in a dependency of the United States.\n\n```\n{\n locality: 'San Juan',\n dependency: 'Puerto Rico',\n dependency_a: 'PR',\n country: 'United States',\n country_a: 'USA'\n}\n```\n\nAddresses and places in dependencies don't normally include the country, resulting in: `San Juan, PR`\n\nThe final example is for a neighbourhood in Paris.\n\n```\n{\n neighbourhood: 'Grange aux Belles Terrage',\n locality: 'Paris',\n county: 'Paris-7E-Arrondissement',\n macrocounty: 'Paris-1Er-Arrondissement',\n region: 'Paris',\n macroregion: 'Île-De-France',\n country: 'France',\n country_a: 'FR'\n}\n```\n\nRegions aren't normally included in France labels, so the label for this would be: `Grange aux Belles Terrage, Paris, France`\n\n#### Configuration\n\nThere are no configuration options at this time. \n\n## Contributing\n\nThis module should be a starting point for contributing to Pelias for those with specific knowledge of how addresses and places are formatted in a specific country. `labelSchemas.js` exports a map keyed by ISO3 country code, so country-specific rules should be added there. \n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/pelias/design/master/logo/pelias_github/Github_markdown_hero.png\"){kind=logo}
\n![](\"https://github.com/pelias/labels/workflows/Continuous%20Integration/badge.svg\"){kind=icon}
\n![](\"https://img.shields.io/github/license/pelias/labels?style=flat&color=orange\")
![](\"https://img.shields.io/gitter/room/pelias/pelias?style=flat&color=yellow\")