Mirrors/bartib
2
0
Fork 0
mirror of https://github.com/nikolassv/bartib synced 2024-11-10 22:24:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

fixed readme file

Browse source
This commit is contained in:
Nikolas Schmidt-Voigt 2021-07-12 22:22:21 +02:00
parent e4eb978274
commit e69882bb91
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,6 +1,6 @@
# Bartib
Bartib is a time tracker for the command line. It safes a journal of all tracked tasks in a plaintext file.
Bartib is a time tracker for the command line. It safes a journal of all tracked activities in a plaintext file.
## Build
@ -12,7 +12,7 @@ cargo build --release
## The `.bartib` file
Bartib safes a journal of all tracked tasks in a plaintext file. The file can either be specified via the `-f / --file` cli option or as a `BARTIB_FILE` environment variable.
Bartib safes a journal of all tracked activities in a plaintext file. The file can either be specified via the `-f / --file` cli option or as a `BARTIB_FILE` environment variable.
## Commands
@ -24,51 +24,51 @@ Print help information:
bartib -h
```
### Start a new task
### Start a new activity
Start a new task with a short description and an associated project:
Start a new activity with a short description and an associated project:
```
bartib start -p "The name of the associated project" -d "A description of the task"
bartib start -p "The name of the associated project" -d "A description of the activity"
```
This will also stop all currently running tasks.
This will also stop all currently running activities.
### Stop a running task
### Stop a running activity
Stops the currently running task:
Stops the currently running activity:
```
bartib stop
```
### List all currently running tasks
### List all currently running activities
```
bartib current
```
### List tasks
### List activities
All tasks:
All activities:
```
bartib list
```
Do not group tasks by date:
Do not group activities by date:
```
bartib list --no_grouping
```
List tasks in a given time range:
List activities in a given time range:
```
bartib list --from 2021-03-01 --to 2021-11-01
```
List tasks on a given day:
List activities on a given day:
```
bartib list --date 2021-05-17