Skip to content

Commit 117f417

Browse files
committed
docs: refresh README layout and styling with brand logo
1 parent 2a9e5e4 commit 117f417

2 files changed

Lines changed: 26 additions & 23 deletions

File tree

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# SlowQL
1+
<div align="center">
22

3-
SlowQL is a **production-focused offline SQL static analyzer** that catches security vulnerabilities, performance regressions, reliability issues, compliance risks, cost inefficiencies, and code quality problems before they reach production.
3+
<img src="assets/logo.png" alt="SlowQL Logo" width="250" />
44

5-
It performs safe static analysis of your SQL source code with **no database connection required**. SlowQL ships with **282 built-in rules** covering **14 SQL dialects**, and is built for modern engineering teams supporting CI/CD pipelines, pre-commit hooks, GitHub Actions, SARIF output, LSP, and automated fixes.
5+
# SlowQL
66

7-
---
7+
**Production-focused offline SQL static analyzer.**
88

9-
<!-- Distribution -->
9+
Catch security vulnerabilities, performance regressions, reliability issues, compliance risks, cost inefficiencies, and code quality problems before they reach production.
1010

1111
<p align="center">
1212
<a href="https://github.com/makroumi/slowql/releases"><img src="https://img.shields.io/github/v/release/makroumi/slowql?logo=github&label=release&color=4c1" alt="Release"></a>
@@ -20,38 +20,41 @@ It performs safe static analysis of your SQL source code with **no database conn
2020
<p align="center">
2121
<a href="https://hub.docker.com/r/makroumi/slowql"><img src="https://img.shields.io/docker/pulls/makroumi/slowql?logo=docker&logoColor=white&label=Docker%20pulls" alt="Docker Pulls"></a>
2222
<a href="https://pypistats.org/packages/slowql"><img src="https://img.shields.io/pypi/dm/slowql?logo=pypi&logoColor=white&label=PyPI%20downloads" alt="PyPI Downloads"></a>
23-
</p>
24-
25-
---
26-
27-
<!-- Build & Quality -->
28-
29-
<p align="center">
3023
<a href="https://github.com/makroumi/slowql/actions/workflows/ci.yml"><img src="https://github.com/makroumi/slowql/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
3124
<a href="https://codecov.io/gh/makroumi/slowql"><img src="https://codecov.io/gh/makroumi/slowql/graph/badge.svg" alt="Coverage"></a>
32-
<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/lint-ruff-46a758?logo=ruff&logoColor=white" alt="Ruff"></a>
33-
<a href="http://mypy-lang.org/"><img src="https://img.shields.io/badge/types-mypy-blue?logo=python&logoColor=white" alt="Mypy"></a>
34-
<a href="https://github.com/makroumi/slowql/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
3525
</p>
3626

37-
---
38-
39-
<!-- Community -->
40-
4127
<p align="center">
28+
<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/lint-ruff-46a758?logo=ruff&logoColor=white" alt="Ruff"></a>
29+
<a href="http://mypy-lang.org/"><img src="https://img.shields.io/badge/types-mypy-blue?logo=python&logoColor=white" alt="Mypy"></a>
4230
<a href="https://github.com/makroumi/slowql/stargazers"><img src="https://img.shields.io/github/stars/makroumi/slowql?style=social" alt="Stars"></a>
4331
<a href="https://github.com/makroumi/slowql/issues"><img src="https://img.shields.io/github/issues/makroumi/slowql?logo=github" alt="Issues"></a>
4432
<a href="https://github.com/makroumi/slowql/discussions"><img src="https://img.shields.io/github/discussions/makroumi/slowql?logo=github" alt="Discussions"></a>
4533
<a href="https://github.com/makroumi/slowql/graphs/contributors"><img src="https://img.shields.io/github/contributors/makroumi/slowql?logo=github&color=success" alt="Contributors"></a>
4634
<a href="https://github.com/sponsors/makroumi"><img src="https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-ea4aaa?logo=githubsponsors&logoColor=white" alt="Sponsor"></a>
4735
<a href="https://snyk.io/test/github/makroumi/slowql"><img src="https://snyk.io/test/github/makroumi/slowql/badge.svg" alt="Known Vulnerabilities"></a>
36+
<a href="https://github.com/makroumi/slowql/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
4837
</p>
4938

39+
*It performs safe static analysis of your SQL source code with **no database connection required**. SlowQL ships with **282 built-in rules** covering **14 SQL dialects**, and is built for modern engineering teams supporting CI/CD pipelines, pre-commit hooks, GitHub Actions, SARIF output, LSP, and automated fixes.*
40+
41+
<br/>
42+
43+
<a href="#-quick-start"><strong>Quick Start</strong></a>
44+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
45+
<a href="#-installation"><strong>Installation</strong></a>
46+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
47+
<a href="#-safe-autofix"><strong>Autofix</strong></a>
48+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
49+
<a href="#vscode-extension"><strong>VS Code Info</strong></a>
50+
51+
</div>
52+
5053
---
5154

52-
<p align="center">
53-
<img src="assets/slowql.gif" alt="SlowQL CLI demo" width="850">
54-
</p>
55+
<div align="center">
56+
<img src="assets/slowql.gif" alt="SlowQL CLI demo" width="850" style="border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);">
57+
</div>
5558

5659
---
5760

@@ -478,7 +481,7 @@ repos:
478481
479482
---
480483
481-
## VS Code Extension
484+
## <a id="vscode-extension"></a>🔌 VS Code Extension
482485
483486
Install [slowql-vscode](https://marketplace.visualstudio.com/items?itemName=Makroumi.slowql-vscode) from the VS Code Marketplace for real-time SQL analysis in your editor. The extension uses the SlowQL LSP server for diagnostics.
484487

assets/logo.png

603 KB
Loading

0 commit comments

Comments
 (0)