Update README

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 95f051ec42d35401ade6f81dc7051612569da2ef..2a988b302e03ad5c392c02688e718d256a70a3c0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -82,11 +82,11 @@ options.
 `token = # MesoWest API token -- only applies when type is mesowest #`  
 `station_id = # the NRCS/MesoWest identifier for a particular station #`  
 `desired_data = # a comma-delimited list of fields you're interested in #`  
-`units = # either english or metric -- only applies when type is mesowest #`  
+`units = # either english, metric, or "American" #`  
 `tz = # any entry from the Olson tz database e.g. America/Denver #`  
 `path = # the filesystem path to the Python program -- only applies when type is python #`  
-`wind_mode = # normal or average #`  
-`hn24 = # yes or no #`  
+`wind_mode = # normal or average -- only applies when type is mesowest #`  
+`hn24 = # true or false -- only applies when type is mesowest #`  
 
 `[infoex]`  
 `host = # InfoEx FTP host address #`  
@@ -206,6 +206,11 @@ There are two features which will cause the program to expand the time
 range of fetched data from three to 24 hours. Please be aware of this
 expansion as it may cause a rise in data/API usage.
 
+**NOTE: Only MesoWest stations have the benefit of wind averaging and
+        HN24 calculation at this time, because generally NRCS SNOTEL
+               stations do not provide wind data. HN24 support for NRCS SNOTEL
+               is planned.
+
 ### Wind mode
 If you go to submit a Wx observation in InfoEx at e.g. 05:05, and have
 so configured InfoEx, it will take the wind speed, wind gust speed, and
@@ -275,6 +280,9 @@ and the conversion will take place through the MesoWest/Synoptic API.
 For NRCS, this program will do the conversion manually, as NRCS does not
 permit specifying the desired unit.
 
+There is an "American" units mode in which precip data is converted to
+metric, and wind data is converted to imperial units.
+
 A note on supported measurements
 --------------------------------
 
@@ -326,6 +334,21 @@ windGustSpeedNum
 Version history
 ---------------
 
+- 3.4.0 (Mar 2022)
+
+  Implement HN24 for NRCS SNOTEL stations, and implement "American"
+  units mode.
+
+- 3.3.1 (Jan 2022)
+
+  Fix bug in which HN24 values under certain circumstances could be
+  inaccurate.
+
+- 3.3.0 (Nov 2021)
+
+  Implement wind averaging and auto-calculation of HN24. These are
+  opt-in via two new configuration options.
+
 - 3.2.4 (Mar 2021)
 
   Fix a small bug that allowed MesoWest HS values to flow through in