Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
muratgozel committed Mar 31, 2024
1 parent 6deccd0 commit 3ebb1ba
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 3ebb1ba

Please sign in to comment.