Skip to content

Commit

Permalink
Additional fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Lilja authored and Erik lilja committed Jul 3, 2017
1 parent 6f9699a commit ad420f2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,31 @@ 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.
`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:

`$ cd bin/ && export PATH=$PATH:$PWD/bin/`
`$ export PATH=$PATH:$PWD/bin/`

This is only temporary though. For being able to consistent run `timelog` wherever you are on the filesystem, please put the export inside a `.profile` or `.zprofile` if you're running `ZSH`.

### Usage
```
Timelog is a script written for keeping track of time for projects.
It will log time inputed via this CLI to store it to the disk in $HOME/.config/timelog/.log.
It will log time inputed via this CLI to store it to the disk in $HOME/.config/timelog/project_id.log.
Usage: timelog
* log (project_id) (start time, end time, break time)
* list project
* show logs (project_id)(week)
* delete project
- log (project_id) (start time, end time, break time)
- list project
- show logs (project_id) (week)
- delete project
For debugging, run with -v
To see examples, run $(basename $0) --examples
To see examples, run timelog --examples
```

### Examples
Expand Down
5 changes: 3 additions & 2 deletions bin/timelog
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ function logger_debug {

function usage {
echo "Timelog is a script written for keeping track of time for projects."
echo "It will log time inputed via this CLI to store it to the disk in \$HOME/.config/timelog/.log."
echo "It will log time inputed via this CLI to store it to the disk in \$HOME/.config/timelog/project_id.log."
echo ""
echo "Usage: $(basename $0)"
echo " * log (project_id) (start time, end time, break time)"
echo " * list project"
echo " * show logs (project_id)(week)"
echo " * show logs (project_id) (week)"
echo " * delete project"
echo ""
echo "For debugging, run with -v"
echo "To see examples, run $(basename $0) --examples"
[ $1 -eq 1 ] && exit 1
exit 0
Expand Down

0 comments on commit ad420f2

Please sign in to comment.