From: Alexander Vasarab <alexander@wylark.com>
Date: Sun, 21 Jun 2020 02:45:57 +0000 (-0700)
Subject: Improve the README ahead of publishing to pip
X-Git-Tag: v2.0.1^0
X-Git-Url: https://wylark.com/src/munter.git/commitdiff_plain/5536d9bc11b8ddf6de540bb4f1924ebf388f751c?hp=199c4afc24dd503212cde2ca87f2c16aa4dd384b

Improve the README ahead of publishing to pip
---

diff --git a/README.md b/README.md
index a61f2d9..03f49c5 100644
--- a/README.md
+++ b/README.md
@@ -13,14 +13,38 @@ estimates is your own fault.
 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
 -------------
 
+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.
+
+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
 and run them through Munter.py and thence record its output to my field
@@ -45,6 +69,10 @@ Future plans
 Version History
 ---------------
 
+- 2.0.1 (Jun 2020)
+
+  README improvement
+
 - 2.0.0 (Jun 2020)
 
   Packaged for distribution as a standalone program (and library).
diff --git a/munter/__init__.py b/munter/__init__.py
index 3f73639..f5c46cb 100755
--- a/munter/__init__.py
+++ b/munter/__init__.py
@@ -1,3 +1,3 @@
 """Main package for Munter.py"""
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 from .munter import time_calc