Skip to content

Commit 95dffc2

Browse files
authored
Simplify installation instructions in README
Removed optional drivers installation instructions for pipx and uv methods.
1 parent 96c6e1e commit 95dffc2

File tree

1 file changed

+3
-27
lines changed

1 file changed

+3
-27
lines changed

README.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -47,53 +47,29 @@ sqlit is a lightweight database TUI that is easy to use and beautiful to look at
4747

4848
### Method 1: `pipx` (Recommended)
4949

50-
This is the recommended method. It installs `sqlit-tui` in an isolated environment, so optional drivers are easy to add later.
51-
5250
1. **Install pipx:** If you don't have pipx, you can install it with:
5351
```bash
5452
python3 -m pip install --user pipx
5553
python3 -m pipx ensurepath
5654
```
57-
*(You may need to restart your terminal after this step)*
5855

5956
2. **Install sqlit-tui:**
6057
```bash
6158
pipx install sqlit-tui
6259
```
6360

64-
3. **Optional drivers (only if you need them):** `sqlit` will tell you what to install when a driver is missing, but you can also pre-install them. For example:
65-
```bash
66-
# PostgreSQL / Supabase / CockroachDB
67-
pipx inject sqlit-tui psycopg2-binary
68-
69-
# MySQL
70-
pipx inject sqlit-tui mysql-connector-python
71-
```
72-
73-
### Method 2: `uv` (Alternative)
61+
### Method 2: `uv`
7462

7563
`uv` is a fast, modern installer. This also keeps things isolated and makes optional drivers easy.
7664

7765
```bash
7866
uv tool install sqlit-tui
7967
```
8068

81-
### Method 3: `pip` (Alternative)
82-
83-
*(Note: To avoid dependency conflicts, installing in a virtual environment is recommended.)*
84-
85-
You can install `sqlit-tui` and drivers directly with `pip` using "extras". The application will guide you if a driver is missing.
86-
If you installed Python via a system package manager (Homebrew, apt, pacman, etc.), `pip install` may be restricted; in that case, use `pipx`, `uv`, or a virtual environment.
69+
### Method 3: `pip`
8770

8871
```bash
89-
# To install with PostgreSQL and MySQL support
90-
pip install "sqlit-tui[postgres,mysql]"
91-
92-
# To add a driver to an existing installation
93-
pip install "sqlit-tui[mariadb]"
94-
95-
# To install all drivers
96-
pip install "sqlit-tui[all]"
72+
pip install "sqlit-tui"
9773
```
9874

9975
## Usage

0 commit comments

Comments
 (0)