Skip to content

Commit bf6752c

Browse files
committed
docs: update README
1 parent e70515c commit bf6752c

1 file changed

Lines changed: 47 additions & 14 deletions

File tree

README.md

Lines changed: 47 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
@@ -190,7 +201,7 @@ Maybe I will drop this in the future, let's see.
190201

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

193-
### New
204+
<details id="new">
194205

195206
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:
196207

@@ -240,7 +251,9 @@ Options:
240251
-h, --help Print help
241252
```
242253

243-
### Start
254+
</details>
255+
256+
<details id="start">
244257

245258
The `start` command may be used to start tracking time for an existing activity.
246259
It expects an **activity handle** which may be either:
@@ -287,7 +300,9 @@ Options:
287300
-h, --help Print help
288301
```
289302

290-
### Cancel
303+
</details>
304+
305+
<details id="cancel">
291306

292307
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293308
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 +322,9 @@ Options:
307322
-h, --help Print help
308323
```
309324

310-
### Pause
325+
</details>
326+
327+
<details id="pause">
311328

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

@@ -329,7 +346,9 @@ Options:
329346
-h, --help Print help
330347
```
331348

332-
### Modify
349+
</details>
350+
351+
<details id="modify">
333352

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

@@ -364,7 +383,9 @@ Options:
364383
-h, --help Print help
365384
```
366385

367-
### Edit
386+
</details>
387+
388+
<details id="edit">
368389

369390
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.
370391
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 +459,9 @@ Options:
438459
-h, --help Print help
439460
```
440461

441-
### Delete
462+
</details>
463+
464+
<details id="delete">
442465

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

@@ -477,7 +500,9 @@ Options:
477500
-h, --help Print help
478501
```
479502

480-
### Get
503+
</details>
504+
505+
<details id="get">
481506

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

@@ -518,7 +543,9 @@ Options:
518543
-h, --help Print help
519544
```
520545

521-
### List
546+
</details>
547+
548+
<details id="list">
522549

523550
The `list` command can be used to get an overview of all the activities you have been tracking.
524551
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 +584,9 @@ Options:
557584
-h, --help Print help
558585
```
559586

560-
### Report
587+
</details>
588+
589+
<details id="report">
561590

562591
The `report` command can be used to get a summary of the total time spent on your activities.
563592
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +608,9 @@ Options:
579608
-h, --help Print help
580609
```
581610

582-
### Init
611+
</details>
612+
613+
<details id="init">
583614

584615
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:
585616

@@ -625,12 +656,14 @@ Options:
625656
-h, --help Print help
626657
```
627658

659+
</details>
660+
628661
## 🔮 Alternatives to boat
629662

630663
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:
631664

632-
- [`bartib`](https://github.com/nikolassv/bartib)
633-
- [`zeit`](https://github.com/mrusme/zeit)
665+
- [`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.
666+
- [`zeit`](https://github.com/mrusme/zeit): Zeit, erfassen. A command line tool for tracking time.
634667

635668
## 🧠 (mostly) Brain made
636669

0 commit comments

Comments
 (0)