Add documentation about environment variables.

bopen · Apr 3, 2016 · 47f59da · 47f59da
1 parent 60d47c2
commit 47f59da
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,8 @@
 - Added ``-r/--reference`` and ``-m/--margin`` options to define the bounds from a GDAL/OGR data source.
   Install the ``rasterio`` and ``fiona`` packages with ``pip`` to enable it.
   Issue `#14 <https://github.com/bopen/elevation/issues/14>`_.
+- Enable reading defaults from environment variables prefixed with ``EIO``,
+  e.g. ``EIO_PRODUCT_PRODCUT=SRTM3`` and ``EIO_CLIP_MARGIN=10%``.
 
 
 0.9.9 (2016-04-01)

diff --git a/README.rst b/README.rst
@@ -110,6 +110,9 @@ The ``clip`` sub-command::
                             output bounds.
       --help                Show this message and exit.
 
+Defaults can be defined by setting environment variables prefixed with ``EIO``,
+e.g. ``EIO_PRODUCT_PRODCUT=SRTM3`` and ``EIO_CLIP_MARGIN=10%``.
+
 
 Python API
 ----------