Small tense fix

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 4a24833e0e31da342fa4eec23edcbf30f69917f7..3b442b56627a1541eab02fda9161885b43c2991d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ This program fetches data from an NRCS SNOTEL or MesoWest station and
 pushes it into the InfoEx system using the new automated weather system
 implementation.
 
 pushes it into the InfoEx system using the new automated weather system
 implementation.
 

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

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


@@ -38,11 +38,16 @@ importation of data into your InfoEx subscriber account.
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 

-`./infoex-autowx.py --config [path/to/config-file.ini] [--dry-run]`
+`./infoex-autowx.py --config path/to/config-file.ini [--dry-run] [--log-level debug|info|warning]`

 
 **NOTE: Specifying --dry-run will also not clean up the generated CSV
 file.** This is so that you can debug any issues more easily.
 
 
 **NOTE: Specifying --dry-run will also not clean up the generated CSV
 file.** This is so that you can debug any issues more easily.
 

+You can also specify `--log-level` as debug, info, warning. The
+resultant log messages will try to be logged to journald, but if that's
+not available, they will be printed to stdout. This output can be
+helpful early on in the setup process.
+

 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
 created earlier):
 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
 created earlier):


@@ -194,14 +199,30 @@ with the data you see in your web browser.
 
 Here's the list of measurements currently supported:
 
 
 Here's the list of measurements currently supported:
 

-precipitationGauge
-tempPres
-hS
-baro
-rH
-windSpeedNum
-windDirectionNum
-windGustSpeedNum (only supported by MesoWest)
+**NRCS:**  
+PREC  
+TOBS  
+SNWD  
+PRES  
+RHUM  
+WSPD  
+WDIR  
+
+**MesoWest:**  
+precip\_accum  
+air\_temp  
+snow\_depth  
+pressure  
+relative\_humidity  
+wind\_speed  
+wind\_direction  
+wind\_gust  
+
+Future plans
+------------
+
+- Improve the documentation
+- Implement unit conversion for NRCS stations

 
 Version history
 ---------------
 
 Version history
 ---------------


@@ -214,6 +235,12 @@ Version history
   hence the major version bump. Such changes are not taken lightly but
   given the desire to support multiple data sources, were necessary.
 
   hence the major version bump. Such changes are not taken lightly but
   given the desire to support multiple data sources, were necessary.
 

+  Other minor changes include:
+
+  - New switches: --log-level and --version.
+  - Better documentation.
+  - Expanded supported measurement types (from three to eight, in number).
+

 - 1.0.0 (Jun 2020)
 
   First released version. Cleaned up the program and design.
 - 1.0.0 (Jun 2020)
 
   First released version. Cleaned up the program and design.