Small changes along with version bump

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 91c4b9848810d65c93b819a8b2c8991ca588253a..eeb9e865e61465f22655b8c24e6fef34d7dbc4f5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ InfoEx AutoWx (IEAW)
 This program fetches data from an NRCS SNOTEL site and pushes it into
 the InfoEx system using the new automated weather system implementation.
 
 This program fetches data from an NRCS SNOTEL site and pushes it into
 the InfoEx system using the new automated weather system implementation.
 

-License under the MIT license (see file: LICENSE).
+License under the ISC license (see file: LICENSE).

 
 Disclaimer
 ----------
 
 Disclaimer
 ----------


@@ -64,18 +64,18 @@ weather station FTP server and other InfoEx-related configuration
 options.
 
 `[station]`  
 options.
 
 `[station]`  

-`type = [either mesowest or nrcs]`  
-`token = [MesoWest API token -- ignored when type is nrcs]`  
-`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 -- ignored when type is nrcs]`  
+`type = # either mesowest or nrcs #`  
+`token = # MesoWest API token -- ignored when type is nrcs #`  
+`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 -- ignored when type is nrcs #`  

 
 `[infoex]`  
 
 `[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]`  
+`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 NRCS `station` values
 ----------------------------------
 
 Finding Your NRCS `station` values
 ----------------------------------


@@ -123,8 +123,10 @@ Once you've chosen your elements, combine all of their respective
 "elementCd" values into a comma-delimited string and put that into your
 configuration file as the `desired_data` value.
 
 "elementCd" values into a comma-delimited string and put that into your
 configuration file as the `desired_data` value.
 

-For example:
+A complete example:

 
 

+`[station]`  
+`type = nrcs`  

 `station_id = 655:OR:SNTL`  
 `desired_data = TOBS,PREC`
 
 `station_id = 655:OR:SNTL`  
 `desired_data = TOBS,PREC`
 


@@ -162,9 +164,11 @@ specified to infoex-autowx via the configuration option `units`. This
 can be either 'english' or 'metric', with 'english' meaning imperial
 units as used in the United States.
 
 can be either 'english' or 'metric', with 'english' meaning imperial
 units as used in the United States.
 

-For example:
+A complete example:

 
 

-`token = (token id located in your MesoWest web account)`  
+`[station]`  
+`type = mesowest`  
+`token = # token id copied from MesoWest web account #`  

 `stid = OD110`  
 `desired_data = air_temp,snow_depth`  
 `units = english`
 `stid = OD110`  
 `desired_data = air_temp,snow_depth`  
 `units = english`