Skip to content

Commit 3e4f217

Browse files
committed
docs: modernize README with badges and improved layout
1 parent e46a88c commit 3e4f217

File tree

1 file changed

+52
-41
lines changed

1 file changed

+52
-41
lines changed

README.md

Lines changed: 52 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1+
<div align="center">
2+
13
# linear-tui
24

3-
A TUI client for [Linear.app](https://linear.app) — manage issues, projects, and cycles from your terminal.
5+
**A TUI client for [Linear.app](https://linear.app) — manage issues, projects, and cycles from your terminal.**
6+
7+
[![Crates.io](https://img.shields.io/crates/v/linear-tui.svg)](https://crates.io/crates/linear-tui)
8+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
9+
[![CI](https://github.com/k1-c/linear-tui/actions/workflows/ci.yml/badge.svg)](https://github.com/k1-c/linear-tui/actions/workflows/ci.yml)
10+
[![Rust](https://img.shields.io/badge/rust-1.85%2B-orange.svg)](https://www.rust-lang.org)
11+
12+
Built with [ratatui](https://ratatui.rs/) and the Linear GraphQL API.
413

5-
Built with Rust using [ratatui](https://ratatui.rs/) and the Linear GraphQL API.
14+
</div>
15+
16+
---
617

718
## Features
819

@@ -22,6 +33,10 @@ Built with Rust using [ratatui](https://ratatui.rs/) and the Linear GraphQL API.
2233
cargo install linear-tui
2334
```
2435

36+
### From GitHub Releases
37+
38+
Pre-built binaries are available for Linux, macOS (Intel/Apple Silicon), and Windows on the [Releases](https://github.com/k1-c/linear-tui/releases) page.
39+
2540
### From source
2641

2742
```sh
@@ -30,58 +45,54 @@ cd linear-tui
3045
cargo install --path .
3146
```
3247

33-
## Authentication
48+
## Getting Started
3449

35-
### OAuth2 (recommended)
50+
### 1. Authenticate
51+
52+
**OAuth2 (recommended)**
3653

3754
```sh
3855
linear-tui auth login
3956
```
4057

41-
This opens your browser for Linear OAuth authorization. Tokens are stored locally and refreshed automatically.
58+
Opens your browser for Linear OAuth authorization. Tokens are stored locally and refreshed automatically.
4259

43-
### Personal API Key
60+
**Personal API Key**
4461

4562
Generate a key at [Linear Settings > API](https://linear.app/settings/api), then:
4663

4764
```sh
4865
linear-tui auth token <your-api-key>
4966
```
5067

51-
### Logout
52-
53-
```sh
54-
linear-tui auth logout
55-
```
56-
57-
## Usage
68+
### 2. Launch
5869

5970
```sh
6071
linear-tui
6172
```
6273

63-
### Keybindings
64-
65-
| Key | Action |
66-
| ----------- | ---------------------------------------------------- |
67-
| `j` / `k` | Move cursor down / up |
68-
| `g` / `G` | Jump to first / last item |
69-
| `Enter` | Open detail view |
70-
| `Esc` / `q` | Back / quit |
71-
| `1`-`4` | Switch tabs (Issues / My Issues / Projects / Cycles) |
72-
| `s` | Change status |
73-
| `p` | Change priority |
74-
| `a` | Change assignee |
75-
| `c` | Add comment (Ctrl+Enter to send) |
76-
| `t` | Switch team |
77-
| `f` / `F` | Filter / clear filters |
78-
| `/` | Search issues |
79-
| `r` | Reload data |
80-
| `?` | Toggle help |
74+
## Keybindings
75+
76+
| Key | Action |
77+
| --- | --- |
78+
| `j` / `k` | Move cursor down / up |
79+
| `g` / `G` | Jump to first / last item |
80+
| `Enter` | Open detail view |
81+
| `Esc` / `q` | Back / quit |
82+
| `1`-`4` | Switch tabs (Issues / My Issues / Projects / Cycles) |
83+
| `s` | Change status |
84+
| `p` | Change priority |
85+
| `a` | Change assignee |
86+
| `c` | Add comment (`Ctrl+Enter` to send) |
87+
| `t` | Switch team |
88+
| `f` / `F` | Filter / clear filters |
89+
| `/` | Search issues |
90+
| `r` | Reload data |
91+
| `?` | Toggle help |
8192

8293
## Configuration
8394

84-
Config file location: `~/.config/linear-tui/config.toml`
95+
Config file: `~/.config/linear-tui/config.toml`
8596

8697
```toml
8798
[auth]
@@ -90,19 +101,19 @@ Config file location: `~/.config/linear-tui/config.toml`
90101
# api_key = "lin_api_xxxxx"
91102

92103
[ui]
93-
default_team = "Core" # Auto-select this team on startup
94-
items_per_page = 50 # Issues per page (pagination)
95-
theme = "default" # "default" | "light" | "ocean"
104+
default_team = "Core" # Auto-select this team on startup
105+
items_per_page = 50 # Issues per page (pagination)
106+
theme = "default" # "default" | "light" | "ocean"
96107
```
97108

98109
### Themes
99110

100-
| Theme | Description |
101-
| --------- | ---------------------------------- |
102-
| `default` | Dark theme with cyan accents |
103-
| `light` | Light background with blue accents |
104-
| `ocean` | Dark blue palette with soft colors |
111+
| Theme | Description |
112+
| --- | --- |
113+
| `default` | Dark theme with cyan accents |
114+
| `light` | Light background with blue accents |
115+
| `ocean` | Dark blue palette with soft colors |
105116

106117
## License
107118

108-
MIT
119+
[MIT](LICENSE)

0 commit comments

Comments
 (0)