Skip to content

Commit

Permalink
fixed type declarations
Browse files Browse the repository at this point in the history
generated api docs with typedoc
  • Loading branch information
muratgozel committed Mar 29, 2023
1 parent daa875e commit ef7331d
Show file tree
Hide file tree
Showing 254 changed files with 606,140 additions and 676,518 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ src/data/city/*
src/data/distances/*
src/data/neighbourhoods/*
src/data/postalCode/*
src/data/perCity/*

**/.DS_Store

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# turkey-neighbourhoods
Always up to date names of cities, districts and neighbourhoods of Turkey, available as JSON and JS.
Always up to date names of cities, districts and neighbourhoods of Turkey, available as JSON and JS. Refer to https://muratgozel.github.io/turkey-neighbourhoods/ for full api documentation.

**In Turkish: **
JSON ve JS formatında, her zaman güncel, Türkiye şehir, posta kodu, plaka kodu, ilçe ve mahalle listesi.
Expand Down Expand Up @@ -56,7 +56,7 @@ findClosestCities('16', 200, 3) // [{code: '77', distance: 69}, ...]
Have a look at the tests, types and source for more info.

## Keeping Data Up To Date
Data updates published regularly as `minor` releases so you only need to update the package as new version comes in. If you have a kind of manual setup, you can run `npm run generate`, `compile`, `build` and `test` to fetch the new data. The module is smart enough to detect if the existing data is fresh or not.
Data updates published regularly as `minor` releases so you only need to update the package as new version comes in. If you have a kind of manual setup, you can run `npm run setup`, `compile`, `build` and `test` to fetch the new data. The module is smart enough to detect if the existing data is fresh or not.

---

Expand Down
Loading

0 comments on commit ef7331d

Please sign in to comment.