From b0010888edc0a4fea8e67e1ea117990da16b3efd Mon Sep 17 00:00:00 2001 From: Mr Martian Date: Fri, 21 Jun 2024 04:02:48 -0600 Subject: [PATCH] improve readme --- Cargo.toml | 2 +- README.md | 1 + s2json-spec/CHANGELOG.md | 18 ++++++------------ 3 files changed, 8 insertions(+), 13 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0c535e6..0f8ac2a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ name = "s2json" version = "0.1.0" edition = "2021" authors = ["Craig O'Connor "] -description = "This library reads/writes The Open Vector Tiles 1.0 Specification" +description = "This library supports the S2JSON 1.0 Specification" documentation = "https://docs.rs/s2json" homepage = "https://github.com/OpenS2/s2json" repository = "https://github.com/OpenS2/s2json" diff --git a/README.md b/README.md index 230a815..bb2f6d8 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Notable features of S2JSON are: * 🧊 Support for 3D geometries. * ♏ Support for M-Values for each geometry point. * ♻️ Feature Properties & M-Values are defined in scope to ensure they can be easily processed by lower level languages as structures, but also adds value to other projects down the line. +* GeoJSON no longer supports `GeometryCollection`. This spec also extends the spec to include M-Values, Attribution, diff --git a/s2json-spec/CHANGELOG.md b/s2json-spec/CHANGELOG.md index 018b81e..972baeb 100755 --- a/s2json-spec/CHANGELOG.md +++ b/s2json-spec/CHANGELOG.md @@ -1,19 +1,13 @@ -# Open Vector Tile Spec Changelog +# S2JSON Spec Changelog ## 1.0.0 Initial release. -Features added from Mapbox Vector Tile Spec: +Rough estimation of the changes from GeoJSON: -* 🔗 lightweight zero dependency builds. -* 🌴 Proper module treeshake. -* 🦺 Complete TypeScript support / safety. -* 🗜 Pre-Tessellated & Indexed geometries to quickly ship data to the renderer. +* Properties data is clearly defined on how it can be shaped. * 🧊 Support for 3D geometries. -* ♏ Support for M-Values for each geometry point (used by lines and polygons). -* ♻️ Feature Properties & M-Values are stored as "Shapes" which reuses objects only needing to do lookups on values. -* 🏛 Column encoding of data to make it more compact. Better gzip and brotli compression. -* 🪺 Support nested objects in properties and m-values. -* 📦 All features support first class BBOX data like IDs. -* 😑 Lines support "offsets" to know the distance it's traveled. +* ♏ Support for M-Values for each geometry point. +* ♻️ Feature Properties & M-Values are defined in scope to ensure they can be easily processed by lower level languages as structures, but also adds value to other projects down the line. +* GeoJSON no longer supports `GeometryCollection`.