Skip to content

Commit

Permalink
Update getting-started.md
Browse files Browse the repository at this point in the history
Add changelog link, update typedef needs
  • Loading branch information
twelch authored Jun 14, 2024
1 parent f9e1831 commit 7b09186
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@ You can also include it directly from a CDN:
<script src="https://cdn.jsdelivr.net/npm/@turf/turf@6/turf.min.js"></script>
```

## Upgrading

When upgrading to a newer version of Turf, see [CHANGELOG](https://github.com/Turfjs/turf/blob/master/CHANGELOG.md) for breaking changes and migration steps.

## TypeScript

TypeScript definitions are packaged with each module. No DefinitelyTyped packages required.
TypeScript definitions are packaged with each module. Turf uses the `@types/geojson` package for base GeoJSON type definitions such as `Polygon`, `FeatureCollection`, etc. and does not re-export them. Users will need to install and import these types directly e.g. `import { Polygon, FeatureCollection } from 'geojson'`.

## Other languages

Expand Down

0 comments on commit 7b09186

Please sign in to comment.