From 1023ff85a9d128954f7bfe57f54f9aea35b9f0ca Mon Sep 17 00:00:00 2001 From: vincentsarago Date: Thu, 21 Jul 2022 10:02:41 +0200 Subject: [PATCH] update readme --- .bumpversion.cfg | 2 +- README.md | 7 +++++-- rio_faux/cli.py | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 5f7394a..eae9161 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -4,6 +4,6 @@ commit = True tag = True tag_name = {new_version} -[bumpversion:file:rio_fake/__init__.py] +[bumpversion:file:rio_faux/__init__.py] search = __version__ = "{current_version}" replace = __version__ = "{new_version}" diff --git a/README.md b/README.md index bfa4f2c..0badd1a 100644 --- a/README.md +++ b/README.md @@ -55,18 +55,21 @@ $ pip install git+https://github.com/cogeotiff/rio-faux.git $ rio faux --help Usage: rio faux [OPTIONS] INPUT OUTPUT - Create Fake copy. + Create empty copy. Options: --forward-band-tags Forward band tags to output bands. + --forward-dataset-tags Forward dataset tags to output image. --co, --profile NAME=VALUE Driver specific creation options. See the documentation for the selected output driver for more information. --config NAME=VALUE GDAL configuration options. --help Show this message and exit. ``` ``` -$ rio faux my_image_i_cant_share.tif public.tif +$ rio faux tests/fixtures/cog_band_tags.tif out.tif ``` +![](https://user-images.githubusercontent.com/10407788/180162026-2a023aa9-9c1b-4277-a3c2-c2865d9d7c43.png) + ## Contribution & Development diff --git a/rio_faux/cli.py b/rio_faux/cli.py index c5d7f68..889aa8d 100644 --- a/rio_faux/cli.py +++ b/rio_faux/cli.py @@ -56,7 +56,7 @@ def faux( creation_options, config, ): - """Create Fake copy.""" + """Create empty copy.""" # Check if the dataset has overviews with rasterio.open(input) as src_dst: ovr = src_dst.overviews(1)