Skip to content

Commit e8cad41

Browse files
committed
📝 Update README.md
1 parent 5ba4b88 commit e8cad41

File tree

1 file changed

+47
-4
lines changed

1 file changed

+47
-4
lines changed

‎README.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,51 @@
11
# SwiftGeo
22

3-
A modern Swift package for working with geographical data.
3+
The toolbox for any Swift project working with geographical data.
44

5-
It contains a lot of Swift ports from [Turf](https://github.com/Turfjs/turf),
6-
but sometimes written in a Swiftier way.
5+
Works on client and server sides – it's just Swift.
76

8-
*This repository is maintained, but not actively.*
7+
## To-do list
8+
9+
> **Note**
10+
> Items are not especially ordered.
11+
12+
- Features
13+
- [x] Geodesic data types
14+
- [x] Coordinate Reference System conversions
15+
- Parsing/printing (using parser-printers)
16+
- Formats
17+
- [ ] GeoJSON
18+
- [ ] WKT
19+
- [ ] GPX
20+
- [ ] Other formats
21+
- [ ] Streaming
22+
- [ ] Full translation of [Turf](https://github.com/Turfjs/turf)
23+
- [ ] Integration with MapKit
24+
- [ ] Code generation to support all EPSG Coordinate Reference Systems
25+
- [ ] Dynamic Coordinate Reference System (for parsing any CRS)
26+
- Developer experience
27+
- [x] Type-safety
28+
- [ ] Comprehensive error handling
29+
- [ ] Packaging
30+
- Documentation
31+
- [ ] Doc comments
32+
- [ ] [DocC](https://www.swift.org/documentation/docc/)
33+
- [ ] Illustrations
34+
- [ ] Online documentation
35+
- [ ] Use cases
36+
- [ ] Playground
37+
- Tests
38+
- [ ] Full coverage
39+
- [ ] Snapshot testing
40+
- Platform compatibility
41+
- [ ] macOS (`MapKit` integration)
42+
- [ ] Others (open-source `Foundation`…)
43+
- Benchmarks
44+
- [ ] Binary size benchmarks (`@inlinable`, optimizations…)
45+
- [ ] Performance benchmarks (CPU, RAM…)
46+
47+
## Development and maintenance
48+
49+
- This repository is being actively developed.
50+
- It will be maintained, but not actively.
51+
- PRs are welcome ❤️ They will be reviewed and integrated unless something is wrong.

0 commit comments

Comments
 (0)