Implement reset button functionality

[munter.git] / README.md

diff --git a/README.md b/README.md
index 03f49c5d12b0cf893ba6bbeb4f8ac3db39e81a7e..37c034c6c4b37a8c84e60d75e63935a001b5e2cf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,7 +27,8 @@ For detailed information, see:
 `./munter.py --help`
 
 The program supports both imperial and metric, and has four "travel
-modes" at this time: uphill, flat, downhill, bushwhacking.
+modes" at this time: uphill, flat, downhill, bushwhacking. It also
+supports a simple fitness modifier: slow, average, fast.
 
 By default, the output will be the time in hours and minutes of the
 specified leg. If you prefer, you can use the `-p` switch to get a
@@ -38,16 +39,16 @@ specified leg. If you prefer, you can use the `-p` switch to get a
 You can also use Munter.py programmatically from Python, like so:
 
 `import munter`  
-`est = munter.time_calc(3.2, 2300, 'uphill', 'imperial')`
+`est = munter.time_calc(distance=3.2, elevation=2300, fitness='slow')`
 
-This will store a value like "3.04095" in the `est` variable.
+This will store a value like "3.64914" in the `est` variable.
 
 Workflow
 --------
 
 My workflow involves planning my tour using tools like ArcGIS or CalTopo. Then,
 I take the stats between each leg (distance, vertical gain/loss) of the tour
-and run them through Munter.py and thence record its output to my field
+and run them through Munter.py and record its output to my field
 notebook.
 
 The rudimentary "GUI" can be directly transferred to e.g. the format used by
@@ -57,25 +58,25 @@ SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
 Future plans
 ------------
 
-* Personal "fitness" switch (to help fine tune your estimates based on
-                                                        your personal fitness level as observed
-                                                        over time)
 * GTK mode
-* Use as a Python library from within another project
 * Lint it (e.g. therapist)
-* Pip?
 * Sphinx/autodoc?
 
 Version History
 ---------------
 
+- 2.1.0 (Jun 2020)
+
+  Implement fitness modifier. Make some text changes and other
+  miscellaneous and minor improvements.
+
 - 2.0.1 (Jun 2020)
 
-  README improvement
+  README improvement.
 
 - 2.0.0 (Jun 2020)
 
-  Packaged for distribution as a standalone program (and library).
+  Package for distribution as a standalone program (and library).
 
 - 1.0.2 (Jun 2020)