Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr Martian committed Jun 21, 2024
1 parent 2f2aa19 commit b001088
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "s2json"
version = "0.1.0"
edition = "2021"
authors = ["Craig O'Connor <oconnorct1@gmail.com>"]
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"
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down
18 changes: 6 additions & 12 deletions s2json-spec/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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`.

0 comments on commit b001088

Please sign in to comment.