Skip to content

Commit 596d943

Browse files
committed
docs: update README
1 parent e70515c commit 596d943

1 file changed

Lines changed: 72 additions & 14 deletions

File tree

README.md

Lines changed: 72 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,18 @@ It relies on [`boat-lib`](https://github.com/coko7/boat-lib) for core functions.
3131
- [Install with a bundled version of SQLite](#install-with-a-bundled-version-of-sqlite)
3232
- [⚙️ Configuration](#%EF%B8%8F-configuration)
3333
- [✨ Usage](#-usage)
34-
- [🔮 Alternatives to boat](-alternatives-to-boat)
34+
- [New](#new)
35+
- [Start](#start)
36+
- [Cancel](#cancel)
37+
- [Pause](#pause)
38+
- [Modify](#modify)
39+
- [Edit](#edit)
40+
- [Delete](#delete)
41+
- [Get](#get)
42+
- [List](#list)
43+
- [Report](#report)
44+
- [Init](#init)
45+
- [🔮 Alternatives to boat](#-alternatives-to-boat)
3546
- [🧠 (mostly) Brain made](#-mostly-brain-made)
3647

3748
## 🚀 Demo
@@ -154,6 +165,7 @@ Commands:
154165
get Get the current activity
155166
list List activity logs
156167
report Show activity summaries
168+
init Generate a default boat config and output to stdout
157169
help Print this message or the help of the given subcommand(s)
158170
159171
Options:
@@ -190,7 +202,11 @@ Maybe I will drop this in the future, let's see.
190202

191203
_I have included some fallback in case you type `stop`/`remove` instead of `pause`/`delete` 👀_
192204

193-
### New
205+
Below is a breakdown of all the available commands and their options:
206+
207+
<details id="new">
208+
209+
<summary>New: Create a new activity</summary>
194210

195211
You can use the `new` command to create a new activity, with an optional **description** and **tags** (comma-separated list). If you want to start the activity immediately, you can include the `-s`/`--start-now` flag:
196212

@@ -240,7 +256,11 @@ Options:
240256
-h, --help Print help
241257
```
242258

243-
### Start
259+
</details>
260+
261+
<details id="start">
262+
263+
<summary>Start: Start/resume an activity</summary>
244264

245265
The `start` command may be used to start tracking time for an existing activity.
246266
It expects an **activity handle** which may be either:
@@ -287,7 +307,11 @@ Options:
287307
-h, --help Print help
288308
```
289309

290-
### Cancel
310+
</details>
311+
312+
<details id="cancel">
313+
314+
<summary>Cancel: Cancel the current activity</summary>
291315

292316
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293317
You can control the confirmation behavior with the `-c`/`--confirm` and `-C`/`--no-confirm` flags or the `confirm` option in the config file.
@@ -307,7 +331,11 @@ Options:
307331
-h, --help Print help
308332
```
309333

310-
### Pause
334+
</details>
335+
336+
<details id="pause">
337+
338+
<summary>Pause</summary>
311339

312340
To stop tracking time for the current activity, you can use the `pause` command:
313341

@@ -329,7 +357,11 @@ Options:
329357
-h, --help Print help
330358
```
331359

332-
### Modify
360+
</details>
361+
362+
<details id="modify">
363+
364+
<summary>Modify: Pause/stop the current activity</summary>
333365

334366
You can modify the **name**, **description**, and **tags** of an existing activity with the `modify` command:
335367

@@ -364,7 +396,11 @@ Options:
364396
-h, --help Print help
365397
```
366398

367-
### Edit
399+
</details>
400+
401+
<details id="edit">
402+
403+
<summary>Edit: Edit activity logs as text in an external editor</summary>
368404

369405
If you want to make adjustments to the activity logs (start/end tracking times), you can make use of the `edit` command. Calling the `edit` command will open the list of logs in CSV format in your default `$EDITOR`. You can tweak the `start`/`end` times for multiple logs in there.
370406
After saving the file and quitting the file, you will be able to preview the changes to be applied and either proceed with the update or discard it.
@@ -438,7 +474,11 @@ Options:
438474
-h, --help Print help
439475
```
440476

441-
### Delete
477+
</details>
478+
479+
<details id="delete">
480+
481+
<summary>Delete: Delete an activity</summary>
442482

443483
You may delete an activity with the `delete` command. This will **permanently delete the activity and all its logs**, so be careful with it.
444484

@@ -477,7 +517,11 @@ Options:
477517
-h, --help Print help
478518
```
479519

480-
### Get
520+
</details>
521+
522+
<details id="get">
523+
524+
<summary>Get: Get the current activity</summary>
481525

482526
Acquiring information about the current activity is really simple. All you need to do is to use the `get` command:
483527

@@ -518,7 +562,11 @@ Options:
518562
-h, --help Print help
519563
```
520564

521-
### List
565+
</details>
566+
567+
<details id="list">
568+
569+
<summary>List: List activity logs</summary>
522570

523571
The `list` command can be used to get an overview of all the activities you have been tracking.
524572
It comes with a lot of options to filter and group the results. You can also output the list in JSON format for further processing in scripts.
@@ -557,7 +605,11 @@ Options:
557605
-h, --help Print help
558606
```
559607

560-
### Report
608+
</details>
609+
610+
<details id="report">
611+
612+
<summary>Report: Show activity summaries</summary>
561613

562614
The `report` command can be used to get a summary of the total time spent on your activities.
563615
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +631,11 @@ Options:
579631
-h, --help Print help
580632
```
581633

582-
### Init
634+
</details>
635+
636+
<details id="init">
637+
638+
<summary>Init: Generate a default boat config and output to stdout</summary>
583639

584640
If, at anytime, you need to get a copy of the default configuration file, you can make use of the `init` command and the full TOML representation will be printed in your terminal for you to copy-paste:
585641

@@ -625,12 +681,14 @@ Options:
625681
-h, --help Print help
626682
```
627683

684+
</details>
685+
628686
## 🔮 Alternatives to boat
629687

630688
Hey. I made `boat` to solve my own very specific problems but I don't expect it to be a perfect fit for everyone. If you are looking for similar tools, I got you:
631689

632-
- [`bartib`](https://github.com/nikolassv/bartib)
633-
- [`zeit`](https://github.com/mrusme/zeit)
690+
- [`bartib`](https://github.com/nikolassv/bartib): A simple timetracker for the command line. It saves a log of all tracked activities as a plaintext file and allows you to create flexible reports.
691+
- [`zeit`](https://github.com/mrusme/zeit): Zeit, erfassen. A command line tool for tracking time.
634692

635693
## 🧠 (mostly) Brain made
636694

0 commit comments

Comments
 (0)