Commit 01f8457
docs: streamline README — 1209 → 155 lines (#382)
* docs: streamline README from 1209 to 155 lines
Now that gosqlx.dev has full docs, playground, benchmarks, and blog,
the README serves as a concise landing page that drives to the website.
Kept: badges, overview, key features, quick start, install (4 methods),
MCP server, documentation link table, performance stats, contributing.
Removed: inline code examples, advanced SQL features, project structure,
testing section, development setup, roadmap, community sections, use cases,
project metrics — all now live at gosqlx.dev.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* docs: add back community, contributing detail, and footer to README
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* docs: redesign README — visual, exciting, contribution-friendly
Fresh design with:
- "Parse SQL at the speed of Go" tagline
- Stats bar (ops/sec, latency, SQL-99, dialects, race conditions)
- "Why GoSQLX?" section — not an ORM, not slow, not limited
- Side-by-side install table (Go/CLI | VS Code/MCP)
- 6-cell feature grid (Parser, Analysis, Tooling, Multi-Dialect, AI-Ready, Battle-Tested)
- Docs table with icons
- Contributing section with TDD emphasis and 24hr review promise
- Community CTA badges (Discussions, Issues, Blog)
- Footer with star CTA
1209 → 215 lines (82% reduction, better design)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* style: replace emdashes with hyphens across 122 files
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Ajit Pratap Singh <ajitpratapsingh@Ajits-Mac-mini-2655.local>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>1 parent d840a46 commit 01f8457
File tree
122 files changed
+451
-1440
lines changed- .claude
- .github
- DISCUSSION_TEMPLATE
- ISSUE_TEMPLATE
- .playwright-mcp
- cmd/gosqlx
- cmd
- internal/actioncmd
- docs
- examples/transform
- pkg
- advisor
- cbinding
- errors
- formatter
- gosqlx
- testing
- mcp
- schema
- sql
- ast
- parser
- security
- tokenizer
- token
- transform
- vscode-extension
- src
- test/unit
- utils
- wasm/playground
- website/src
- components
- content/blog
- pages
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
122 files changed
+451
-1440
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
Loading
Loading
Loading
Loading
Loading
0 commit comments