mirror of
https://github.com/Turfjs/turf.git
synced 2026-01-25 16:07:00 +00:00
a8cbea3a48
* Moved "optional" project documentation files to docs/ subdir to minimise clutter in project root. * Verbatim copy of Contributor Covenant v2.1. Updated code of conduct contact details, removing anyone who don't list obvious contact details (@lyzidiamond and @tcql). * Split publishing topic out into a separate document. Only a small subset of contributors will ever publish so better to have CONTRIBUTING focus on coding and PR related activities. * Updated issue and PR templates to read a bit better, ask for more meaningful details. * Updating open collective stats, project goals for coming year. * Split readme into a few pieces. Cut a lot of cut and paste commands (hard to guarantee currency). Removed REGEN references - think it's use should be discouraged, though probably differing opinions on that one! Co-authored-by: mfedderly <24275386+mfedderly@users.noreply.github.com> Co-authored-by: Tim Welch <tim.j.welch@gmail.com> --------- Co-authored-by: mfedderly <24275386+mfedderly@users.noreply.github.com> Co-authored-by: Tim Welch <tim.j.welch@gmail.com>
31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
## About Turf.js
|
|
|
|
[TurfJS](http://turfjs.org/) is a modular geospatial analysis library designed for use in the browser as well as Node.js.
|
|
We provide almost 120 modules for people to use freely in their applications.
|
|
Our most [popular module](https://www.npmjs.com/package/@turf/helpers) is downloaded 4,200,000 times a week via npm.
|
|
|
|
|
|
## Why we're looking for support
|
|
|
|
TurfJS is a community-driven project maintained by a small group of core contributors who work on the project in their spare time.
|
|
Time is spent investigating issues, supporting users, improving documentation, fixing bugs, and adding new functionality.
|
|
Your funding will go directly to development costs, marketing campaigns, promotional events, and other expenses needed to maintain and promote TurfJS.
|
|
|
|
In particular, we're looking for corporate sponsors who use TurfJS in revenue-generating ways, either by creating applications for clients, or through use in an app used by customers.
|
|
Of course individuals are welcome to support us as well if TurfJS has helped you :)
|
|
|
|
## 2024 Achievements
|
|
|
|
- First major release in a few years
|
|
- Modernised build and publishing infrastructure
|
|
- Merged many PRs that had been on hold
|
|
- Resolved several long standing bugs
|
|
- Overhauled the [documentation website](https://turfjs.org)
|
|
|
|
## Goals for 2025
|
|
|
|
- Continue to work through the bug backlog
|
|
- Release more often
|
|
- Encourage more contributors by engaging with PRs
|
|
- Resolve disparities between planar and spherical modes
|