Update README
authorAlexander Vasarab <alexander@wylark.com>
Thu, 3 Mar 2022 23:06:24 +0000 (15:06 -0800)
committerAlexander Vasarab <alexander@wylark.com>
Thu, 3 Mar 2022 23:06:24 +0000 (15:06 -0800)
README.md

index cde6bd150500e68106ff163d866f1c7dcafe7071..2a988b302e03ad5c392c02688e718d256a70a3c0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -82,7 +82,7 @@ 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 -- only applies when type is mesowest #`  
@@ -280,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
 --------------------------------
 
@@ -333,7 +336,8 @@ Version history
 
 - 3.4.0 (Mar 2022)
 
-  Implement HN24 for NRCS SNOTEL stations.
+  Implement HN24 for NRCS SNOTEL stations, and implement "American"
+  units mode.
 
 - 3.3.1 (Jan 2022)