Skip to content

Commit 69e8f6e

Browse files
committed
updates README
1 parent 7a0b524 commit 69e8f6e

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

README.md

+26-21
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,47 @@ It integrates with [Toggl](http://track.toggl.com/) and [Harvest](https://www.ge
88
The key feature is the ability to set monthly goal for each client.
99
Billable provides monthly estimates, daily and weekly targets based on the definied goal.
1010

11+
## Output example
12+
13+
```bash
14+
# billable -s -m 2
15+
[Toggl]
16+
February 2023
17+
My Second Client 19:00 🟢 23:28/20:00 🎯 0:15 a day, 1:15 a week
18+
My First Client 23:00 🔴 28:24/30:00 🎯 1:45 a day, 8:45 a week
19+
January 2023
20+
My Second Client 30:00 🟢 30:00/20:00
21+
My First Client 17:00 🔴 17:00/30:00
22+
23+
[Harvest]
24+
February 2023
25+
Harvest Client 27:00 🟢 33:21/33:00 🎯 1:30 a day, 7:30 a week
26+
January 2023
27+
Harvest Client 35:00 🟢 35:00/33:00
28+
```
29+
1130
## Configuration
1231

1332
Configuration file `config.toml` is loaded from:
1433
* current directory
1534
* or `~/Library/Application Support/com.robertwijas.billable`
1635

17-
Make sure the `config.toml` file is available in either one of these two locations. You can copy and modify the example configuation:
18-
https://github.com/robertwijas/billable-rust/blob/712609831f2790c9fa3ad6bdc71198b7ec4c3bd1/config.toml.example#L1-L11
19-
20-
```bash
21-
22-
```
23-
36+
Running `billable` presents and option to create a sample config.
2437

2538
## Usage
2639

2740
```bash
28-
billable --help
41+
# billable --help
2942
Usage: billable [OPTIONS]
3043

3144
Options:
32-
-m, --months <MONTHS> [default: 1]
45+
-m, --months <MONTHS> [default: 1]
3346
-s, --show-minutes
34-
-h, --help Print help
47+
-c, --config-name <CONFIG_NAME> [default: config]
48+
-h, --help Print help
3549
```
3650

37-
## Todos
51+
## Todos/Features
3852

3953
- [x] show hours for current month per client
4054
- [x] remove hardcoded month
@@ -52,15 +66,11 @@ Options:
5266
- [x] add harvest
5367
- [x] add demo reports provider
5468
- [x] automatically create configuration if missing, based on the `config.toml.example`
69+
- [x] add example output to README (preferably based on the demo report)
5570
- [ ] replace colored with console
5671
- [ ] extract styling code using Style from console
57-
- [ ] add example output to README (preferably based on the demo report)
5872
- [ ] adjust first column width to the longest client name
59-
- [ ] write better README
6073
- [ ] create CHANGELOG
61-
62-
# Ideas
63-
6474
- [ ] support holidays (?) or allow to somehow override working days
6575
- [ ] add option to display _Total_ row for all clients
6676
- [ ] add option to show weekly reports
@@ -70,8 +80,3 @@ Options:
7080
- [ ] auto currency conversion
7181
- [ ] implement async http requests
7282

73-
## Notes
74-
75-
### How to store configuration?
76-
77-
This looks good: https://docs.rs/config/latest/config/.

0 commit comments

Comments
 (0)