More README cleanup

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 8dde3f0887cbe4f5dcb0b9d6a00ac5f8f1cca45a..91c4b9848810d65c93b819a8b2c8991ca588253a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -52,20 +52,23 @@ created earlier):
 Configuration File
 ------------------
 
-The configuration file is separated into two parts, the
-[nrcs]/[mesowest] portion, and the [infoex] portion.
+The configuration file is separated into two parts, the [station]
+portion, and the [infoex] portion.
 
-The [nrcs]/[mesowest] values describe which weather station's data
-you're after. See the next section in this README for instructions on
-obtaining these values.
+The [station] values describe which weather station's data you're after.
+See the next section in this README for instructions on obtaining these
+values.
 
 The [infoex] values describe your credentials for the InfoEx automated
 weather station FTP server and other InfoEx-related configuration
 options.
 
-`[nrcs]`  
-`station_triplet = [The NRCS identifier for a particular SNOTEL site]`  
-`desired_data = [A comma-delimited list of NRCS elements you're interested in]`  
+`[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]`  
 
 `[infoex]`  
 `host = [InfoEx FTP host address]`  
@@ -74,11 +77,12 @@ options.
 `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 values
-------------------------
+Finding Your NRCS `station` values
+----------------------------------
 
-To complete the [nrcs] configuration section, you must fill in the
-attributes of the NRCS SNOTEL site from which you want to import data.
+To complete the [station] configuration section for an NRCS station, you
+must fill in the attributes of the NRCS SNOTEL site from which you want
+to import data.
 
 Here are the steps to do that:
 
@@ -94,7 +98,7 @@ Here are the steps to do that:
    4-digit number).
 
 3. Combine your Station ID, state abbreviation, and the network type
-   "SNTL" to get your station triplet (`station_triplet`, in the
+   "SNTL" to get your NRCS station triplet (`station_id`, in the
    configuration file). For example:
 
    655:OR:SNTL
@@ -103,9 +107,9 @@ Here are the steps to do that:
    of Oregon (OR). SNTL just represents that the station is in the
    SNOTEL network and is used internally by NRCS.
 
-Once you have your station triplet, fill in the field in your
-configuration file. Now you must select which data you'd like to pull
-from NRCS to push into InfoEx.
+Once you have your station ID, fill in the field in your configuration
+file. Now you must select which data you'd like to pull from NRCS to
+push into InfoEx.
 
 For that, visit the NRCS web service:
 
@@ -121,33 +125,34 @@ configuration file as the `desired_data` value.
 
 For example:
 
-`station_triplet = 655:OR:SNTL`  
+`station_id = 655:OR:SNTL`  
 `desired_data = TOBS,PREC`
 
 indicates that I'd like to import "AIR TEMPERATURE OBSERVED" and
 "PRECIPITATION ACCUMULATION" from the NRCS SNOTEL site at Mud Ridge, OR,
 into InfoEx.
 
-Finding your MesoWest values
-----------------------------
+Finding your MesoWest `station` values
+--------------------------------------
 
 MesoWest has great documentation which can be found here:
 
 https://developers.synopticdata.com/mesonet/v2/getting-started/
 
-To complete the [mesowest] configuration section, you must fill in the
-attributes of the MesoWest station ID from which you want to import
-data. Here are the steps to do that:
+To complete the [station] configuration section for a MesoWest station,
+you must fill in the attributes of the MesoWest station ID from which
+you want to import data. Here are the steps to do that:
 
 1. Firstly, get set up with MesoWest's API by going to the above
    'Getting Started' link. Once you're set up, you can copy a token from
    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
-   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/
@@ -159,7 +164,7 @@ units as used in the United States.
 
 For example:
 
-`token = (token id)`  
+`token = (token id located in your MesoWest web account)`  
 `stid = OD110`  
 `desired_data = air_temp,snow_depth`  
 `units = english`