Browse Source

Add a basic README

Samuel W. Flint 3 years ago
parent
commit
0938a709fd
1 changed files with 20 additions and 0 deletions
  1. 20 0
      README.md

+ 20 - 0
README.md

@@ -0,0 +1,20 @@
+#  Track Calorie Values
+
+This package provides a method to keep track of the values between
+foods and the amount of calories per serving.
+
+At the moment, this packages is fairly simple, but there's a chance to
+extend it to other nutritional data or more general data.
+
+## Usage
+
+To start a calorie value capture/matching session, use
+`track-calorie-values-food` (it will return the name of the food
+selected).  It may be completed with `track-calorie-values-calories`
+which will return the calories if cached, or prompt for them
+otherwise.
+
+## Contributing
+
+If you'd like to contribute, please send patches to
+~swflint/public-inbox@lists.sr.ht.