Change prefix cb_ to rb_ for accuracy

[munter.git] / README.md

diff --git a/README.md b/README.md
index 891d7f3ceb4dc43a1e97a4007c0c677dd1841cca..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
 `./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
 
 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,9 +39,9 @@ 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`  
 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
 --------
 
 Workflow
 --------


@@ -57,13 +58,8 @@ SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
 Future plans
 ------------
 
 Future plans
 ------------
 

-* Personal "fitness" switch (to help fine tune your estimates based on
-                                                        your personal fitness level as observed
-                                                        over time)

 * GTK mode
 * GTK mode

-* Use as a Python library from within another project

 * Lint it (e.g. therapist)
 * Lint it (e.g. therapist)

-* Pip?

 * Sphinx/autodoc?
 
 Version History
 * Sphinx/autodoc?
 
 Version History