Skip to content

Commit 01f8457

Browse files
ajitpratap0Ajit Pratap Singhclaude
authored
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

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

.claude/settings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"enabledPlugins": {
3+
"qodo-skills@claude-plugins-official": true,
4+
"pagerduty@claude-plugins-official": true
5+
}
6+
}

.github/DISCUSSION_TEMPLATE/ideas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ labels: ["enhancement"]
3030

3131
- [ ] I can open an issue and submit a PR after community discussion
3232
- [ ] I'd love help from maintainers / other contributors
33-
- [ ] I'm just sharing an idea no commitment
33+
- [ ] I'm just sharing an idea - no commitment

.github/DISCUSSION_TEMPLATE/show-and-tell.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
labels: ["showcase"]
33
---
44

5-
<!-- Share how you're using GoSQLX! Projects, integrations, benchmarks, blog posts all welcome. -->
5+
<!-- Share how you're using GoSQLX! Projects, integrations, benchmarks, blog posts - all welcome. -->
66

77
## What did you build?
88

@@ -18,7 +18,7 @@ labels: ["showcase"]
1818

1919
## Benchmark / impact (optional)
2020

21-
<!-- Query volume, performance gains, team size anything that shows real-world impact. -->
21+
<!-- Query volume, performance gains, team size - anything that shows real-world impact. -->
2222

2323
---
2424

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ assignees: ''
1010

1111
<!-- Which file, section, or topic is affected? Link to the specific page if possible. -->
1212

13-
**File / section**: <!-- e.g. docs/CLI_GUIDE.md gosqlx analyze section -->
13+
**File / section**: <!-- e.g. docs/CLI_GUIDE.md - gosqlx analyze section -->
1414

1515
## What is wrong or missing?
1616

15.2 KB
Loading
63.4 KB
Loading
276 KB
Loading
57.7 KB
Loading
295 KB
Loading
54 KB
Loading

0 commit comments

Comments
 (0)