Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Erik lilja committed Jul 3, 2017
1 parent bade6df commit 6f9699a
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
[![Stories in Ready](https://badge.waffle.io/Lilja/timelog.png?label=ready&title=Ready)](https://waffle.io/Lilja/timelog?utm_source=badge)

# Timelog
## CLI Utility to log time for different projects.
CLI Utility to log time for different projects.

## Introduction
`Timelog` is used to as a CLI to log time for projects. The purpose of this tool is to have a terminal friendly tool that can easily track time(since terminals are fast and easy these days).

`Timelog` used to be a conversion tool that turned military time(`HH:mm`) to decimal time. I([@Lilja](https://github.com/lilja/)) worked for a company that used to log their time in decimal time(where working 8 hours and 30 minutes is not `8:30` but `8.5`). After a couple of iterations it turned from a conversion tool into a time logging tool. This new repository with a full re-write has more tools and support to log multiple different projects.

### Installation
Clone the repository, then just add the `bin` directory to the `$PATH` by running:
Expand All @@ -26,16 +31,21 @@ To see examples, run $(basename $0) --examples

### Examples
`timelog create project`
to create a new project(interactivly)

to create a new project(interactively)

`timelog list projects`

to list current projects that are configured

`timelog log project (project id) (start time, end time, break time)`

to log project for `project id` using `start time` `end time` `break time`

`timelog show logs (project id) (week number)`

to show logs for a `project id` during `week number`

`timelog delete project`
to delete a project(interactivly)

to delete a project(interactively)

0 comments on commit 6f9699a

Please sign in to comment.