From 155f129616f98651954668fdf61037fce51cda24 Mon Sep 17 00:00:00 2001 From: Brandon Liu Date: Sun, 27 Mar 2022 19:27:41 +0800 Subject: [PATCH] readme updates --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21b0f74..700f9d4 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Builds [vector tilesets](https://github.com/mapbox/vector-tile-spec/) from large This intends to be an actively maintained fork of [tippecanoe](https://github.com/mapbox/tippecanoe) originally developed by [Erica Fischer](https://github.com/e-n-f) at Mapbox. Version 2.0.0 is equivalent to [1.36.0](https://github.com/mapbox/tippecanoe/tree/1.36.0) in the original repository. Thank you Mapbox and Erica for an incredible tool! +Key features of this fork include: + +* Support for [FlatGeobuf](https://github.com/flatgeobuf/flatgeobuf) input which is more compact and 5-10x faster than GeoJsonSeq input. + Intent ------ @@ -304,7 +308,7 @@ If your input is formatted as newline-delimited GeoJSON, use `-P` to make input * `-l` _name_ or `--layer=`_name_: Use the specified layer name instead of deriving a name from the input filename or output tileset. If there are multiple input files specified, the files are all merged into the single named layer, even if they try to specify individual names with `-L`. * `-L` _name_`:`_file.json_ or `--named-layer=`_name_`:`_file.json_: Specify layer names for individual files. If your shell supports it, you can use a subshell redirect like `-L` _name_`:<(cat dir/*.json)` to specify a layer name for the output of streamed input. - * `-L{`_layer-json_`}` or `--named-layer={`_layer-json_`}`: Specify an input file and layer options by a JSON object. The JSON object must contain a `"file"` key to specify the filename to read from. (If the `"file"` key is an empty string, it means to read from the standard input stream.) It may also contain a `"layer"` field to specify the name of the layer, and/or a `"description"` field to specify the layer's description in the tileset metadata, and/or a `"format"` field to specify `csv` or `geobuf` file format if it is not obvious from the `name`. Example: + * `-L{`_layer-json_`}` or `--named-layer={`_layer-json_`}`: Specify an input file and layer options by a JSON object. The JSON object must contain a `"file"` key to specify the filename to read from. (If the `"file"` key is an empty string, it means to read from the standard input stream.) It may also contain a `"layer"` field to specify the name of the layer, and/or a `"description"` field to specify the layer's description in the tileset metadata, and/or a `"format"` field to specify `csv` or `fgb` file format if it is not obvious from the `name`. Example: ``` tippecanoe -z5 -o world.mbtiles -L'{"file":"ne_10m_admin_0_countries.json", "layer":"countries", "description":"Natural Earth countries"}' @@ -325,7 +329,7 @@ If the input file begins with the [RFC 8142](https://tools.ietf.org/html/rfc8142 parallel processing of input will be invoked automatically, splitting at record separators rather than at all newlines. -Parallel processing will also be automatic if the input file is in Geobuf format. +Parallel processing will also be automatic if the input file is in FlatGeobuf format. ### Projection of input