diff --git a/README.md b/README.md index eb1ae45..b69c2e4 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -... +# Markdown Timesheet + +A command line interface to total up the time entries in a markdown file. + +# Usage + +Given a `timesheet.md` like so: + +``` +# 5 Sep 2019 + +## 9:15-9:16 +Write spec, write client email. + - wrote really basic spec + - told client I'm starting the project + +## 9:16-9:25 +Write tests + +``` + +Then, + +``` +$ add timesheet.md +10 +``` + +# Installation + +``` +pip install markdown_timesheet +```