Skip to content

Commit 9613d7b

Browse files
committed
docs: enhance discoverability and growth strategy
Implement comprehensive documentation improvements to boost project discovery and conversion: **Package Updates:** - Update package.json description to emphasize "ChatGPT Apps SDK" - Add high-value keywords: chatgpt-apps-sdk, react-components, ui-components, chatgpt-ui, mcp **README Enhancements:** - Update title to "AINativeKit - ChatGPT Apps SDK UI" for better SEO - Add npm downloads badge and GitHub stars badge (social proof) - Remove TypeScript badge (cleaner badge section) - Add "Who This Is For" section targeting ChatGPT Apps developers - Add comparison table showing value proposition (before/after) - Replace Contributing section with "Support the Project" (stronger CTAs) - Add SEO footer with keywords and descriptive paragraph **Strategy:** These changes optimize for: 1. NPM search discoverability ("ChatGPT Apps SDK" in description/keywords) 2. GitHub search ranking (keyword-rich content, topics) 3. Social proof (star badge, downloads badge) 4. Conversion (clear target audience, comparison table, strong CTAs) Applied to both root README.md and packages/ui/README.md for consistency.
1 parent 0e8bfac commit 9613d7b

File tree

3 files changed

+91
-24
lines changed

3 files changed

+91
-24
lines changed

README.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# 🧩 AI Native Kit UI
1+
# 🧩 AINativeKit - ChatGPT Apps SDK UI
22

3-
> **Instantly turn MCP JSON results into polished ChatGPT App UIs.**
4-
> OpenAI Figma‑aligned **React** components purpose‑built for the [ChatGPT Apps SDK](https://developers.openai.com/apps-sdk).
3+
**The React UI library for [ChatGPT Apps SDK](https://developers.openai.com/apps-sdk)**
4+
5+
> Production-ready components, hooks, and design system to build beautiful ChatGPT Apps 10x faster. OpenAI Figma-aligned, fully typed, and accessible.
56
67
[![npm version](https://img.shields.io/npm/v/@ainativekit/ui.svg)](https://www.npmjs.com/package/@ainativekit/ui)
8+
[![npm downloads](https://img.shields.io/npm/dm/@ainativekit/ui.svg)](https://www.npmjs.com/package/@ainativekit/ui)
9+
[![GitHub stars](https://img.shields.io/github/stars/AINativeKit/chatgpt-apps-sdk-ui?style=social)](https://github.com/AINativeKit/chatgpt-apps-sdk-ui)
710
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
8-
[![TypeScript](https://img.shields.io/badge/TypeScript-%233178C6.svg?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
911
[![Storybook](https://img.shields.io/badge/Storybook-%23FF4785.svg?logo=storybook&logoColor=white)](https://www.ainativekit.com)
1012

1113
![AINativeKit - ChatGPT Apps SDK UI demo](https://raw.githubusercontent.com/AINativeKit/chatgpt-apps-sdk-ui/main/assets/ainativekit-ui-demo.gif)
@@ -26,6 +28,15 @@
2628

2729
> **Why now?** ChatGPT Apps (via the Apps SDK) expose results + UI metadata. This kit renders those results as native widgets with minimal code.
2830
31+
## 👥 Who This Is For
32+
33+
**You should use AINativeKit if you're:**
34+
- ✅ Building ChatGPT Apps with the [Apps SDK](https://developers.openai.com/apps-sdk)
35+
- ✅ Converting MCP/tool JSON outputs into user interfaces
36+
- ✅ Want production-ready components instead of building from scratch
37+
- ✅ Need OpenAI Figma design consistency out-of-the-box
38+
- ✅ Value TypeScript, accessibility, and developer experience
39+
2940
## 💡 Why You'll Love It
3041

3142
| Developer Pain Point | How AINativeKit UI Helps |
@@ -36,6 +47,19 @@
3647
| Accessibility concerns | **WCAG 2.1 AA** mindful components with ARIA support |
3748
| Poor developer experience | 100% **TypeScript**, IntelliSense, Storybook docs |
3849

50+
## 🆚 Why AINativeKit - ChatGPT Apps SDK UI?
51+
52+
| What You'd Usually Do | With AINativeKit |
53+
| --------------------- | ---------------- |
54+
| ❌ Hand-wire 50+ lines of JSX per card |`<SummaryCard {...data} />` |
55+
| ❌ Search for Figma design specs | ✅ Figma-aligned tokens included |
56+
| ❌ Build icons from scratch | ✅ 417 typed icons ready |
57+
| ❌ Set up dark mode manually | ✅ Automatic theme detection |
58+
| ❌ Write custom hooks for SDK |`useOpenAiGlobal()` hooks included |
59+
| ❌ Test accessibility yourself | ✅ WCAG 2.1 AA tested |
60+
61+
**Bottom line:** Ship features, not infrastructure.
62+
3963
## 🚀 Core Features
4064

4165
- 🎯 **Apps SDK Optimized:** Components designed to work seamlessly with ChatGPT Apps SDK
@@ -428,15 +452,16 @@ Repository (for documentation & tooling):
428452

429453
Have ideas? Please open an issue or PR!
430454

431-
## 🤝 Contributing
455+
## 🌟 Support the Project
432456

433-
Contributions welcome! Please:
457+
If AINativeKit saves you time:
434458

435-
1. **Star** the repo to support visibility 🙌
436-
2. **Open an issue** to discuss new features/bugs
437-
3. **Fork** -> create a feature branch -> open a **PR**
459+
1. **⭐ Star this repo** - Helps other ChatGPT Apps developers discover us
460+
2. **🐦 Share on Twitter/X** - Spread the word about building ChatGPT Apps faster
461+
3. **💬 Join discussions** - Share what you're building in [GitHub Discussions](https://github.com/AINativeKit/chatgpt-apps-sdk-ui/discussions)
462+
4. **🤝 Contribute** - See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines
438463

439-
See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines.
464+
**Every star helps us grow the ChatGPT Apps SDK ecosystem!**
440465

441466
## 🔗 Links
442467

@@ -451,4 +476,10 @@ Built for the **OpenAI Apps SDK** community. Inspired by ChatGPT App examples, O
451476

452477
**Made with ❤️ by and for ChatGPT App developers.**
453478

454-
Stop wiring UIs manually, start shipping faster with **AI Native Kit UI**.
479+
Stop wiring UIs manually, start shipping faster with **AINativeKit**.
480+
481+
---
482+
483+
**Keywords:** ChatGPT Apps SDK, ChatGPT UI components, React ChatGPT library, OpenAI Apps SDK UI, ChatGPT components, MCP JSON to UI, ChatGPT widget components, OpenAI Figma design system, React UI library, ChatGPT Apps development
484+
485+
_AINativeKit is the React component library for developers building ChatGPT Apps with the official OpenAI Apps SDK. Get production-ready UI components, hooks, icons, and design tokens - all optimized for ChatGPT Apps._

packages/ui/README.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# 🧩 AI Native Kit UI
1+
# 🧩 AINativeKit - ChatGPT Apps SDK UI
22

3-
> **Instantly turn MCP JSON results into polished ChatGPT App UIs.**
4-
> OpenAI Figma‑aligned **React** components purpose‑built for the [ChatGPT Apps SDK](https://developers.openai.com/apps-sdk).
3+
**The React UI library for [ChatGPT Apps SDK](https://developers.openai.com/apps-sdk)**
4+
5+
> Production-ready components, hooks, and design system to build beautiful ChatGPT Apps 10x faster. OpenAI Figma-aligned, fully typed, and accessible.
56
67
[![npm version](https://img.shields.io/npm/v/@ainativekit/ui.svg)](https://www.npmjs.com/package/@ainativekit/ui)
8+
[![npm downloads](https://img.shields.io/npm/dm/@ainativekit/ui.svg)](https://www.npmjs.com/package/@ainativekit/ui)
9+
[![GitHub stars](https://img.shields.io/github/stars/AINativeKit/chatgpt-apps-sdk-ui?style=social)](https://github.com/AINativeKit/chatgpt-apps-sdk-ui)
710
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
8-
[![TypeScript](https://img.shields.io/badge/TypeScript-%233178C6.svg?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
911
[![Storybook](https://img.shields.io/badge/Storybook-%23FF4785.svg?logo=storybook&logoColor=white)](https://www.ainativekit.com)
1012

1113
![AINativeKit UI demo](https://raw.githubusercontent.com/AINativeKit/chatgpt-apps-sdk-ui/main/assets/ainativekit-ui-demo.gif)
@@ -26,6 +28,15 @@
2628

2729
> **Why now?** ChatGPT Apps (via the Apps SDK) expose results + UI metadata. This kit renders those results as native widgets with minimal code.
2830
31+
## 👥 Who This Is For
32+
33+
**You should use AINativeKit if you're:**
34+
- ✅ Building ChatGPT Apps with the [Apps SDK](https://developers.openai.com/apps-sdk)
35+
- ✅ Converting MCP/tool JSON outputs into user interfaces
36+
- ✅ Want production-ready components instead of building from scratch
37+
- ✅ Need OpenAI Figma design consistency out-of-the-box
38+
- ✅ Value TypeScript, accessibility, and developer experience
39+
2940
## 💡 Why You'll Love It
3041

3142
| Developer Pain Point | How AINativeKit UI Helps |
@@ -36,6 +47,19 @@
3647
| Accessibility concerns | **WCAG 2.1 AA** mindful components with ARIA support |
3748
| Poor developer experience | 100% **TypeScript**, IntelliSense, Storybook docs |
3849

50+
## 🆚 Why AINativeKit - ChatGPT Apps SDK UI?
51+
52+
| What You'd Usually Do | With AINativeKit |
53+
| --------------------- | ---------------- |
54+
| ❌ Hand-wire 50+ lines of JSX per card |`<SummaryCard {...data} />` |
55+
| ❌ Search for Figma design specs | ✅ Figma-aligned tokens included |
56+
| ❌ Build icons from scratch | ✅ 417 typed icons ready |
57+
| ❌ Set up dark mode manually | ✅ Automatic theme detection |
58+
| ❌ Write custom hooks for SDK |`useOpenAiGlobal()` hooks included |
59+
| ❌ Test accessibility yourself | ✅ WCAG 2.1 AA tested |
60+
61+
**Bottom line:** Ship features, not infrastructure.
62+
3963
## 🚀 Core Features
4064

4165
- 🎯 **Apps SDK Optimized:** Components designed to work seamlessly with ChatGPT Apps SDK
@@ -428,15 +452,16 @@ Repository (for documentation & tooling):
428452

429453
Have ideas? Please open an issue or PR!
430454

431-
## 🤝 Contributing
455+
## 🌟 Support the Project
432456

433-
Contributions welcome! Please:
457+
If AINativeKit saves you time:
434458

435-
1. **Star** the repo to support visibility 🙌
436-
2. **Open an issue** to discuss new features/bugs
437-
3. **Fork** -> create a feature branch -> open a **PR**
459+
1. **⭐ Star this repo** - Helps other ChatGPT Apps developers discover us
460+
2. **🐦 Share on Twitter/X** - Spread the word about building ChatGPT Apps faster
461+
3. **💬 Join discussions** - Share what you're building in [GitHub Discussions](https://github.com/AINativeKit/chatgpt-apps-sdk-ui/discussions)
462+
4. **🤝 Contribute** - See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines
438463

439-
See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines.
464+
**Every star helps us grow the ChatGPT Apps SDK ecosystem!**
440465

441466
## 🔗 Links
442467

@@ -451,4 +476,10 @@ Built for the **OpenAI Apps SDK** community. Inspired by ChatGPT App examples, O
451476

452477
**Made with ❤️ by and for ChatGPT App developers.**
453478

454-
Stop wiring UIs manually, start shipping faster with **AI Native Kit UI**.
479+
Stop wiring UIs manually, start shipping faster with **AINativeKit**.
480+
481+
---
482+
483+
**Keywords:** ChatGPT Apps SDK, ChatGPT UI components, React ChatGPT library, OpenAI Apps SDK UI, ChatGPT components, MCP JSON to UI, ChatGPT widget components, OpenAI Figma design system, React UI library, ChatGPT Apps development
484+
485+
_AINativeKit is the React component library for developers building ChatGPT Apps with the official OpenAI Apps SDK. Get production-ready UI components, hooks, icons, and design tokens - all optimized for ChatGPT Apps._

packages/ui/package.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@ainativekit/ui",
33
"version": "0.9.0",
4-
"description": "AI Native Kit - Component library for AI-powered applications",
4+
"description": "React UI component library for ChatGPT Apps SDK - Production-ready components, hooks, and design system",
55
"type": "module",
66
"main": "./dist/index.cjs",
77
"module": "./dist/index.js",
@@ -40,7 +40,12 @@
4040
"design-system",
4141
"typescript",
4242
"chatgpt-apps",
43-
"openai-sdk"
43+
"openai-sdk",
44+
"chatgpt-apps-sdk",
45+
"react-components",
46+
"ui-components",
47+
"chatgpt-ui",
48+
"mcp"
4449
],
4550
"author": "AI Native Kit",
4651
"license": "MIT",

0 commit comments

Comments
 (0)