Skip to content

Commit 847feab

Browse files
committed
docs: update README
1 parent e70515c commit 847feab

1 file changed

Lines changed: 71 additions & 14 deletions

File tree

README.md

Lines changed: 71 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,11 @@ 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+
Below is a breakdown of all the available commands and their options:
205+
206+
<details id="new">
207+
208+
<summary>New</summary>
194209

195210
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:
196211

@@ -240,7 +255,11 @@ Options:
240255
-h, --help Print help
241256
```
242257

243-
### Start
258+
</details>
259+
260+
<details id="start">
261+
262+
<summary>Start</summary>
244263

245264
The `start` command may be used to start tracking time for an existing activity.
246265
It expects an **activity handle** which may be either:
@@ -287,7 +306,11 @@ Options:
287306
-h, --help Print help
288307
```
289308

290-
### Cancel
309+
</details>
310+
311+
<details id="cancel">
312+
313+
<summary>Cancel</summary>
291314

292315
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293316
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 +330,11 @@ Options:
307330
-h, --help Print help
308331
```
309332

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

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

@@ -329,7 +356,11 @@ Options:
329356
-h, --help Print help
330357
```
331358

332-
### Modify
359+
</details>
360+
361+
<details id="modify">
362+
363+
<summary>Modify</summary>
333364

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

@@ -364,7 +395,11 @@ Options:
364395
-h, --help Print help
365396
```
366397

367-
### Edit
398+
</details>
399+
400+
<details id="edit">
401+
402+
<summary>Edit</summary>
368403

369404
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.
370405
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 +473,11 @@ Options:
438473
-h, --help Print help
439474
```
440475

441-
### Delete
476+
</details>
477+
478+
<details id="delete">
479+
480+
<summary>Delete</summary>
442481

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

@@ -477,7 +516,11 @@ Options:
477516
-h, --help Print help
478517
```
479518

480-
### Get
519+
</details>
520+
521+
<details id="get">
522+
523+
<summary>Get</summary>
481524

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

@@ -518,7 +561,11 @@ Options:
518561
-h, --help Print help
519562
```
520563

521-
### List
564+
</details>
565+
566+
<details id="list">
567+
568+
<summary>List</summary>
522569

523570
The `list` command can be used to get an overview of all the activities you have been tracking.
524571
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 +604,11 @@ Options:
557604
-h, --help Print help
558605
```
559606

560-
### Report
607+
</details>
608+
609+
<details id="report">
610+
611+
<summary>Report</summary>
561612

562613
The `report` command can be used to get a summary of the total time spent on your activities.
563614
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +630,11 @@ Options:
579630
-h, --help Print help
580631
```
581632

582-
### Init
633+
</details>
634+
635+
<details id="init">
636+
637+
<summary>Init</summary>
583638

584639
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:
585640

@@ -625,12 +680,14 @@ Options:
625680
-h, --help Print help
626681
```
627682

683+
</details>
684+
628685
## 🔮 Alternatives to boat
629686

630687
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:
631688

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

635692
## 🧠 (mostly) Brain made
636693

0 commit comments

Comments
 (0)