Fix another README inconsistency

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index beee3aac9299edb75ad63c346a64e17b575bba54..a08fbf5b1970c5138f4c747bb657a67cdb49d84e 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,17 +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]`  
+`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
 ----------------------------------


@@ -122,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`
 


@@ -147,10 +150,11 @@ you want to import data. Here are the steps to do that:
    the MesoWest web portal into your configuration file's `token` value.
 
 2. Next, you will want to find the Station ID for the MesoWest weather
    the MesoWest web portal into your configuration file's `token` value.
 
 2. Next, you will want to find the Station ID for the MesoWest weather

-   station of interest and copy it to the `stid` value.
+   station of interest and copy it to the `station_id` value.

 
 3. Finally, you must choose what data types you want to push into
 
 3. Finally, you must choose what data types you want to push into

-   InfoEx.  MesoWest refers to these as 'field names' and a list is
+   InfoEx and compile them into a comma-separated list. MesoWest refers
+   to these as 'field names' or 'station variables' and a list is

    available here:
 
 https://developers.synopticdata.com/about/station-variables/
    available here:
 
 https://developers.synopticdata.com/about/station-variables/


@@ -160,10 +164,12 @@ 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)`  
-`stid = OD110`  
+`[station]`  
+`type = mesowest`  
+`token = # token id copied from MesoWest web account #`  
+`station_id = OD110`  

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