Commit ba2b92a
committed
docs(readme): document what the parser returns
The README showed which methods exist but never what they give back, so
the only way to learn the shape of a placemark, a style or the GeoJSON
output was to run the parser and print it. It also said nothing about
which KML elements are supported, which matters more now that
MultiGeometry, LineStyle, PolyStyle and SimpleData landed: users had no
way to know those work, or that Folder and NetworkLink do not.
Adds a supported elements table, the exact array shape of every getter,
the accepted namespaces, the exception hierarchy, and notes on the parts
that surprise people: MultiGeometry has geometries instead of
coordinates, absent style keys are not defaults, colours stay in KML
aabbggrr order, and the facade binding is scoped rather than a
singleton.
Also adds the missing CONTRIBUTING.md, which the README has linked to
since the first release.1 parent 48c1472 commit ba2b92a
2 files changed
Lines changed: 297 additions & 70 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
0 commit comments