Skip to content

Commit fca6c58

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

1 file changed

Lines changed: 69 additions & 14 deletions

File tree

README.md

Lines changed: 69 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,9 @@ 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">
205+
206+
<summary>New</summary>
194207

195208
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:
196209

@@ -240,7 +253,11 @@ Options:
240253
-h, --help Print help
241254
```
242255

243-
### Start
256+
</details>
257+
258+
<details id="start">
259+
260+
<summary>Start</summary>
244261

245262
The `start` command may be used to start tracking time for an existing activity.
246263
It expects an **activity handle** which may be either:
@@ -287,7 +304,11 @@ Options:
287304
-h, --help Print help
288305
```
289306

290-
### Cancel
307+
</details>
308+
309+
<details id="cancel">
310+
311+
<summary>Cancel</summary>
291312

292313
If you started an activity by mistake, you can use the `cancel` command to quickly revert it.
293314
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 +328,11 @@ Options:
307328
-h, --help Print help
308329
```
309330

310-
### Pause
331+
</details>
332+
333+
<details id="pause">
334+
335+
<summary>Pause</summary>
311336

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

@@ -329,7 +354,11 @@ Options:
329354
-h, --help Print help
330355
```
331356

332-
### Modify
357+
</details>
358+
359+
<details id="modify">
360+
361+
<summary>Modify</summary>
333362

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

@@ -364,7 +393,11 @@ Options:
364393
-h, --help Print help
365394
```
366395

367-
### Edit
396+
</details>
397+
398+
<details id="edit">
399+
400+
<summary>Edit</summary>
368401

369402
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.
370403
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 +471,11 @@ Options:
438471
-h, --help Print help
439472
```
440473

441-
### Delete
474+
</details>
475+
476+
<details id="delete">
477+
478+
<summary>Delete</summary>
442479

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

@@ -477,7 +514,11 @@ Options:
477514
-h, --help Print help
478515
```
479516

480-
### Get
517+
</details>
518+
519+
<details id="get">
520+
521+
<summary>Get</summary>
481522

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

@@ -518,7 +559,11 @@ Options:
518559
-h, --help Print help
519560
```
520561

521-
### List
562+
</details>
563+
564+
<details id="list">
565+
566+
<summary>List</summary>
522567

523568
The `list` command can be used to get an overview of all the activities you have been tracking.
524569
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 +602,11 @@ Options:
557602
-h, --help Print help
558603
```
559604

560-
### Report
605+
</details>
606+
607+
<details id="report">
608+
609+
<summary>Report</summary>
561610

562611
The `report` command can be used to get a summary of the total time spent on your activities.
563612
It uses the same filtering options as the `list` command but **does not support grouping yet.**
@@ -579,7 +628,11 @@ Options:
579628
-h, --help Print help
580629
```
581630

582-
### Init
631+
</details>
632+
633+
<details id="init">
634+
635+
<summary>Init</summary>
583636

584637
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:
585638

@@ -625,12 +678,14 @@ Options:
625678
-h, --help Print help
626679
```
627680

681+
</details>
682+
628683
## 🔮 Alternatives to boat
629684

630685
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:
631686

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

635690
## 🧠 (mostly) Brain made
636691

0 commit comments

Comments
 (0)