Skip to content
This repository has been archived by the owner on Jan 6, 2022. It is now read-only.

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maxvw committed Feb 11, 2021
1 parent 7edfea2 commit 3335ec7
Show file tree
Hide file tree
Showing 3 changed files with 459 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A small utility to help you keep track of time.
## Description
I needed a way to easily keep track of what I've been working on, I started by keeping track in a simple text file but as expected this quickly became unwieldly. Of course there are a plentitude of tools available to help you do this, but I took this opportunity to have a new little side project. I built it using Rust, a language I am not familiar with at all, and my main goal is to make something that works for me and my workflow. If it works for you too, that's even better!

![Animated demonstration](docs/demo.gif?raw=true "Demo")
![Animated demonstration](docs/demo.svg?raw=true "Demo")

The demo really quickly runs through some of the possibilities, but run `timecop help` and play around with it a little bit before actually using it. Resetting is as simple as throwing away the database file (`~/.timecopdb`).

Expand All @@ -27,5 +27,24 @@ You can then view your output with `timecop output` (add more detail with `--det

> **NOTE:** About data storage, it's completely local using a SQLite database located at `~/.timecopdb`, I would still avoid storing sensitive data in your log entries.
## `timecop help`
```
timecop 0.1.0
helps you keep track of time spent working.
USAGE:
timecop <SUBCOMMAND>
OPTIONS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
init initialize a new project
log add a new entry for this project
output output the tasks performed by day for this project
help Prints this message or the help of the given subcommand(s)
```

## Contributing
Feel free to open PRs with improvements.
Binary file removed docs/demo.gif
Binary file not shown.
Loading

0 comments on commit 3335ec7

Please sign in to comment.