Fix tense in README for consistency

[munter.git] / README.md

diff --git a/README.md b/README.md
index 32c792f9332d20c64e7c95ab403d492303cab12b..7203e84625433b153711d063656ffc7996eafc9e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,17 +13,41 @@ estimates is your own fault.
 Installation
 ------------
 
 Installation
 ------------
 

-There is no installation and there are no dependencies external to the Python
-standard library.
+If you use pip, then simply `pip install munter.py`.
+
+If you don't use pip, then download the source code and unpack it into
+its own directory. You can invoke it directly via `python munter.py
+[options]`.

 
 How to use it
 -------------
 
 
 How to use it
 -------------
 

+For detailed information, see:
+

 `./munter.py --help`
 
 `./munter.py --help`
 

+The program supports both imperial and metric, and has four "travel
+modes" at this time: uphill, flat, downhill, bushwhacking.
+
+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
+"prettier" output.
+
+### Use as a library
+
+You can also use Munter.py programmatically from Python, like so:
+
+`import munter`  
+`est = munter.time_calc(3.2, 2300, 'uphill', 'imperial')`
+
+This will store a value like "3.04095" 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
 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
 notebook.
 
 The rudimentary "GUI" can be directly transferred to e.g. the format used by


@@ -45,10 +69,17 @@ Future plans
 Version History
 ---------------
 
 Version History
 ---------------
 

+- 2.0.1 (Jun 2020)
+
+  README improvement.
+
+- 2.0.0 (Jun 2020)
+
+  Package for distribution as a standalone program (and library).
+

 - 1.0.2 (Jun 2020)
 
 - 1.0.2 (Jun 2020)
 

-  Packaged for distribution as a standalone program as well as a
-  library. Also contains a few small bugfixes.
+  A few small bugfixes.

 
 - 1.0.1 (Jun 2020)
 
 
 - 1.0.1 (Jun 2020)