Skip to content

Commit 520a290

Browse files
committed
docs(readme): drop experimental warnings, add centered Redis logo header
- Remove the orange shields.io "Status: Experimental" badge and the matching blockquote callout. The Experimental tier note still lives in the docs site for context; the README no longer leads with it. - Replace the plain `# sql-redis` title with a centered hero block matching the redisvl README pattern: Redis logo (canonical SVG from `redis/redis-vl-python/docs/_static/`) + `<h1>sql-redis</h1>` + one-line tagline + a Documentation / GitHub / PyPI link bar. - Surface the published docs URL prominently right after the hero so new readers land on the live site before scrolling. - Move the local docs preview command (`make docs-serve`) into the existing Development section where the other `make` targets live.
1 parent c9869ce commit 520a290

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
# sql-redis
1+
<div align="center">
2+
<img width="300" src="https://raw.githubusercontent.com/redis/redis-vl-python/main/docs/_static/Redis_Logo_Red_RGB.svg" alt="Redis">
3+
<h1>sql-redis</h1>
4+
<p><strong>SQL on top of RediSearch and RedisVL indexes</strong></p>
5+
</div>
26

3-
[![Status: Experimental](https://img.shields.io/badge/status-experimental-orange)](https://redis.io/ai-hub/)
7+
<div align="center">
48

5-
A SQL-to-Redis translator that converts SQL `SELECT` statements into Redis `FT.SEARCH` and `FT.AGGREGATE` commands. Query Redis collections with familiar SQL on top of RediSearch and RedisVL indexes.
9+
**[Documentation](https://redis-developer.github.io/sql-redis/)****[GitHub](https://github.com/redis-developer/sql-redis)****[PyPI](https://pypi.org/project/sql-redis/)**
610

7-
> **Status: Experimental.** sql-redis is in the [Redis AI Hub](https://redis.io/ai-hub/) under the Experimental tier. The API can change between minor releases. Not yet production-ready; we are validating the design and the SQL surface in real use.
11+
</div>
812

9-
Full documentation: **<https://redis-developer.github.io/sql-redis/>** (Diataxis-aligned: concepts, how-to guides, API reference, examples). Built with MkDocs Material from [`docs/`](docs/) and deployed to GitHub Pages on every push to `main`.
13+
---
1014

11-
Build the site locally:
15+
A SQL-to-Redis translator that converts SQL `SELECT` statements into Redis `FT.SEARCH` and `FT.AGGREGATE` commands. Query Redis collections with familiar SQL on top of RediSearch and RedisVL indexes.
1216

13-
```bash
14-
uv sync --group docs
15-
make docs-serve # http://localhost:8000
16-
```
17+
Full docs (concepts, how-to guides, API reference, examples) are at <https://redis-developer.github.io/sql-redis/>.
1718

1819
## Install
1920

@@ -440,6 +441,7 @@ make install # uv sync --all-extras
440441
make test # requires Docker for testcontainers
441442
make test-cov # with coverage report
442443
make lint # format + mypy
444+
make docs-serve # uv sync --group docs && preview at http://localhost:8000
443445
```
444446

445447
## Testing philosophy

0 commit comments

Comments
 (0)