Update README with preliminary new version text
[infoex-autowx.git] / README.md
index 258c70a4cf0c124896a8bfdd033d4dae71ce311b..59b8a9ab5be3bfe41cc836b9f661a6c160dfae0a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -37,7 +37,10 @@ data into your InfoEx subscriber account.
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 
-`./infoex-autowx.py --config [path/to/config-file.ini]`
+`./infoex-autowx.py --config [path/to/config-file.ini] [--dry-run]`
+
+**NOTE: Specifying --dry-run will also not clean up the generated CSV
+file.** This is so that you can debug any issues more easily.
 
 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
@@ -59,16 +62,16 @@ values.
 The [ftp] values describe your credentials for the InfoEx automated
 weather station FTP server.
 
-`[wxsite]`  
+`[nrcs]`  
 `station_triplet = [The NRCS identifier for a particular SNOTEL site]`  
 `desired_data = [A comma-delimited list of NRCS elements you're interested in]`  
-`location_uuid = [The UUID used by InfoEx to identify your automated Wx site]`  
-`csv_filename = [Arbitrary name of the file that will be uploaded to InfoEx]`  
 
-`[ftp]`  
+`[infoex]`  
 `host = [InfoEx FTP host address]`  
 `uuid = [InfoEx-supplied UUID]`  
 `api_key = [InfoEx-supplied API Key]`  
+`csv_filename = [Arbitrary name of the file that will be uploaded to InfoEx]`  
+`location_uuid = [The UUID used by InfoEx to identify your automated Wx site]`  
 
 Finding Your WXSITE values
 --------------------------
@@ -126,6 +129,14 @@ into InfoEx.
 Version History
 ---------------
 
+- 2.0.0 (Jul 2020)
+
+  Implement MesoWest integration.
+
+  This release also makes significant changes to the configuration file,
+  hence the major version bump. Such changes are not taken lightly but
+  given the desire to support multiple data sources, were necessary.
+
 - 1.0.0 (Jun 2020)
 
   First released version. Cleaned up the program and design.