diff --git a/README.md b/README.md index 754f390..52e80b9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # turkey-neighbourhoods -Always up to date names of cities, districts and neighbourhoods of Turkey. +Always up to date names of cities, districts and neighbourhoods of Turkey + city distances. **In Turkish: ** -Her zaman güncel, Türkiye şehir, posta kodu, plaka kodu, ilçe ve mahalle listesi. +Her zaman güncel, Türkiye şehir, posta kodu, plaka kodu, ilçe ve mahalle listesi + şehirlerarası mesafeler. ## Install ```sh @@ -16,6 +16,8 @@ or inject with script tag: ## Usage The package contains large amount of data which is not suitable for browser environment. Benefit from tree-shaking might work if you are interested in small chunks of it. +There are no **states** in Turkey. The data structured as cities (city code and name), districts (name) and neighbourhoods (name). City codes are two digit text and they also known as plate number. + There are couple of methods to interact with the data: ```js import { diff --git a/package.json b/package.json index 166ae8b..9c2ff29 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "turkey-neighbourhoods", - "version": "4.0.1", - "description": "Always up to date names of cities, districts and neighbourhoods in Turkey.", + "version": "4.0.2", + "description": "Always up to date names of cities, districts and neighbourhoods of Turkey + city distances. / Her zaman güncel, Türkiye şehir, posta kodu, plaka kodu, ilçe ve mahalle listesi + şehirlerarası mesafeler.", "type": "module", "main": "./dist/index.cjs", "module": "./dist/index.js",