From b45f213d37779d521620acdcbfd048d143ae7f0e Mon Sep 17 00:00:00 2001 From: Frank Jimenez Date: Sun, 19 May 2024 22:47:45 +0100 Subject: [PATCH] ci: update README usage --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67c6dd8..ae9da7d 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,17 @@ Mboff is tiny CLI that allows the optimisation of MBTiles by removing unnecessary data. You only need to provide it with a key/value pair and `mboff` will search and remove such data. ## Usage -`mboff` requires the user to give a path to the existing *MBTiles* file and the key/value pair of the data you wish to remove from the file: +`mboff` requires you to at least give a path to the existing *MBTiles* file and the key/value pair of the data you wish to remove from the file. Optionally, you may want to filter the removal of data by zoom level: ```bash -mboff [file path] [key value pair] +mboff [file path] [key value pair] [zoom level] ``` -Example: +Examples: ```bash +# Remove data that contains category=road key/value pair mboff myMap.mbtiles category=road + +# Remove data that contains category=road key/value pair in zoom level 10 +mboff myMap.mbtiles category=road 10 ``` ## Future