Skip to content

Commit edc1b96

Browse files
committed
Improve readme
1 parent 59a0263 commit edc1b96

File tree

1 file changed

+45
-34
lines changed

1 file changed

+45
-34
lines changed

README.md

Lines changed: 45 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,50 @@
11
<p align="center">
2-
<img src="assets/favorites/logo_sqlit.png" alt="sqlit logo" width="200">
2+
<img src="assets/favorites/logo_sqlit.png" alt="sqlit logo" width="180">
33
</p>
4+
5+
<h3 align="center">The lazygit of SQL databases</h3>
6+
47
<p align="center">
5-
<strong>The lazygit of SQL databases.</strong><br>
6-
Connect and query your database from your terminal in seconds.
8+
<em>Connect and query your database from your terminal in seconds.</em>
79
</p>
10+
811
<p align="center">
912
<a href="https://github.com/Maxteabag/sqlit/stargazers"><img src="https://img.shields.io/github/stars/Maxteabag/sqlit?style=flat&color=yellow" alt="GitHub Stars"></a>
1013
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python">
1114
<img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License">
1215
</p>
16+
17+
<p align="center">
18+
<code>pipx install sqlit-tui</code>
19+
</p>
20+
1321
<p align="center">
14-
<a href="https://www.buymeacoffee.com/PeterAdams"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me a Coffee" width="200"></a>
22+
<a href="https://www.buymeacoffee.com/PeterAdams"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=flat&logo=buy-me-a-coffee&logoColor=black" alt="Buy Me a Coffee"></a>
1523
</p>
1624

25+
---
26+
1727
### Connect
18-
Sqlit supports all major DBMS's: SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, FirebirdSQL, Oracle, DuckDB, CockroachDB, ClickHouse, Snowflake, Supabase, CloudFlare D1 and Turso.
28+
Supports all major databases: SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, FirebirdSQL, Oracle, DuckDB, CockroachDB, ClickHouse, Snowflake, Supabase, CloudFlare D1, and Turso.
29+
1930
![Database Providers](demos/demo-providers.gif)
2031

2132
### Query
22-
Syntax highlighting. History. VIM-like combos.
33+
Syntax highlighting. History. Vim-style keybindings.
34+
2335
![Query History](demos/demo-history.gif)
24-
### **Results**
25-
Inspect data, filter based on content, supports fuzzy search, loads millions of rows without any problem.
36+
37+
### Results
38+
Inspect data, filter by content, fuzzy search, and load millions of rows without breaking a sweat.
39+
2640
![Filter results](demos/demo-filter/demo-filter.gif)
2741

28-
### **Docker discovery**
29-
Finds running docker sql resources. Connect to your local test servers in seconds without any configuration.
30-
![Filter results](demos/demo-docker-picker.gif)
42+
### Docker Discovery
43+
Automatically finds running database containers. Connect to local test servers in seconds—no configuration needed.
3144

45+
![Docker Discovery](demos/demo-docker-picker.gif)
3246

47+
---
3348

3449
## Features
3550

@@ -49,6 +64,7 @@ Finds running docker sql resources. Connect to your local test servers in second
4964
- Themes (Rose Pine, Tokyo Night, Nord, Gruvbox)
5065
- **Dependency wizard** - User friendly installation for required packages and drivers
5166

67+
---
5268

5369
## Motivation
5470

@@ -64,30 +80,16 @@ Something wasn't right. I asked myself, why is it that running SQL queries can't
6480

6581
`sqlit` is for the developer who just wants to query their database with a user friendly UI without their RAM being eaten alive. It is a lightweight, beautiful, and keyboard-driven TUI designed to make accessing your data enjoyable, fast and easy like it should be-- all from inside your favorite terminal.
6682

67-
## Installation
68-
69-
### Method 1: `pipx` (Recommended)
70-
```bash
71-
pipx install sqlit-tui
72-
```
83+
---
7384

74-
### Method 2: `uv`
75-
76-
```bash
77-
uv tool install sqlit-tui
78-
```
79-
80-
### Method 3: `pip`
81-
82-
```bash
83-
pip install "sqlit-tui"
84-
```
85-
86-
### Method 4: `aur`
85+
## Installation
8786

88-
```bash
89-
yay -S python-sqlit-tui
90-
```
87+
| Method | Command |
88+
| :----- | :------ |
89+
| pipx *(recommended)* | `pipx install sqlit-tui` |
90+
| uv | `uv tool install sqlit-tui` |
91+
| pip | `pip install sqlit-tui` |
92+
| aur | `yay -S python-sqlit-tui` |
9193

9294
## Usage
9395

@@ -181,7 +183,10 @@ sqlit connections delete "MyConnection"
181183

182184
Autocomplete triggers automatically in INSERT mode. Use `Tab` to accept.
183185

184-
You can also receive autocompletion on columns by typing the table name and hitting "."
186+
> [!TIP] Column autocomplete
187+
> Type a table name followed by `.` to get column autocompletion.
188+
189+
---
185190

186191
## Configuration
187192

@@ -202,6 +207,8 @@ Key differences:
202207
- **No CLI config required** - Just run `sqlit` and pick a connection from the UI
203208
- **Lightweight** - While Lazysql or Harlequin offer more features, I experienced that for the vast majority of cases, all I needed was a simple and fast way to connect and run queries. Sqlit is focused on doing a limited amount of things really well.
204209

210+
---
211+
205212
## Inspiration
206213

207214
sqlit is built with [Textual](https://github.com/Textualize/textual) and inspired by:
@@ -246,10 +253,14 @@ SSH tunnel functionality requires additional dependencies. Install with the `ssh
246253

247254
If you try to create an SSH connection without these dependencies, sqlit will detect this and show you the exact command to install them for your environment.
248255

256+
---
257+
249258
## Star History
250259

251260
[![Star History Chart](https://api.star-history.com/svg?repos=Maxteabag/sqlit&type=Date)](https://star-history.com/#Maxteabag/sqlit&Date)
252261

262+
---
263+
253264
## License
254265

255266
MIT

0 commit comments

Comments
 (0)