Skip to content

Commit 5a06f2f

Browse files
committed
docs: add banner to README
1 parent adc1982 commit 5a06f2f

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22

33
`boat` - A **B**asic **O**pinionated **A**ctivity **T**racker, inspired by [bartib](https://github.com/nikolassv/bartib).
44

5-
![demo](https://github.com/user-attachments/assets/007809ee-fda9-4848-bc1c-ccd0131a3616)
6-
7-
> [!TIP]
8-
> The `mp4` version of the demo is available [here](https://github.com/user-attachments/assets/919cb800-1d65-4c3f-bbae-a3195db3b3f6)
5+
<img width="1280" height="640" alt="boat-cli" src="https://github.com/user-attachments/assets/0cb3114c-7128-470b-8f6c-516056cedafa" />
96

107
Like its name implies, `boat` allows you to track the time you spend on everyday tasks.
118

@@ -22,19 +19,21 @@ It relies on [`boat-lib`](https://github.com/coko7/boat-lib) for core functions.
2219
![Rust](https://img.shields.io/github/languages/top/coko7/boat-cli?color=orange)
2320
[![Tests](https://github.com/coko7/boat-cli/actions/workflows/rust.yml/badge.svg)](https://github.com/coko7/boat-cli/actions/workflows/rust.yml)
2421

25-
> [!WARNING]
26-
> 🚧 Work in Progress
27-
>
28-
> This cli is actively being developed. Since it's in its early stages, things will likely break often.
29-
> Don't use it for now.
30-
3122
## Contents
3223

33-
- [🤔 Why was this tool created?](#🤔-why-was-this-tool-created)
34-
- [🛠️ Installation](#🛠️-installation)
24+
- [🚀 Demo](#-demo)
25+
- [🤔 Why was this tool created?](#-why-was-this-tool-created)
26+
- [🛠️ Installation](#-installation)
3527
- [Install with a bundled version of SQLite](#install-with-a-bundled-version-of-sqlite)
36-
- [⚙️ Configuration](#⚙️-configuration)
37-
- [✨ Usage](#✨-usage)
28+
- [⚙️ Configuration](#-configuration)
29+
- [✨ Usage](#-usage)
30+
31+
## 🚀 Demo
32+
33+
![demo](https://github.com/user-attachments/assets/007809ee-fda9-4848-bc1c-ccd0131a3616)
34+
35+
> [!TIP]
36+
> The `mp4` version of the demo is available [here](https://github.com/user-attachments/assets/919cb800-1d65-4c3f-bbae-a3195db3b3f6)
3837
3938
## 🤔 Why was this tool created?
4039

0 commit comments

Comments
 (0)