Skip to content

Commit 2d7a4ab

Browse files
docs: update readme (#58)
1 parent efbc0c8 commit 2d7a4ab

File tree

2 files changed

+6
-23
lines changed

2 files changed

+6
-23
lines changed

README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ https://github.com/user-attachments/assets/bd0c3f18-e98a-4050-bf22-46b198fadac2
5454

5555
CodeRio can be seamlessly integrated into Cursor as a Skill. Simply input a prompt like **"Create a React project and restore this design with high fidelity,"** along with your output directory, Figma URL([Design Link](https://www.figma.com/design/c0UBII8lURfxZIY8W6tSDR/Top-16-Websites-of-2024---Awwwards--Community-?node-id=30-8264&t=FB3Hohq2nsH7ZFts-4)), and Token. The Agent will guide you step-by-step through the page generation process. For Landing Pages, it achieves **high-fidelity restoration**, accurately reproducing images and styles. It also automatically encapsulates reusable components (such as cards) and strictly adheres to **frontend development best practices**.
5656

57-
https://github.com/user-attachments/assets/a66dc680-f68d-4121-b416-aa6b778bd895
57+
58+
https://github.com/user-attachments/assets/43817e97-ffd2-40e3-9d33-78ee55b2ec2d
5859

5960
## 🚀 Quick Start
6061

@@ -235,24 +236,9 @@ Beyond visual fidelity, the generated code is built for long-term maintenance:
235236
- [ ] Vue.js and Svelte support
236237
- [ ] Custom design system integration
237238

238-
## 🤝 Contributing
239-
240-
we welcome contributions!
241-
242-
```bash
243-
git clone https://github.com/MigoXLab/coderio.git
244-
cd coderio
245-
pnpm install
246-
pnpm build
247-
```
248-
249-
### Contributors
250-
251-
Thanks to all our contributors! 🎉
239+
### 🤝 Contributors
252240

253-
<a href="https://github.com/MigoXLab/coderio/graphs/contributors">
254-
<img src="https://contrib.rocks/image?repo=MigoXLab/coderio" />
255-
</a>
241+
Welcome to contribute. Thanks to all our contributors! 🎉
256242

257243
## 📄 License
258244

README_zh-CN.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ https://github.com/user-attachments/assets/bd0c3f18-e98a-4050-bf22-46b198fadac2
5353

5454
CodeRio 支持作为 Skill 集成到 Cursor 中使用。您只需在对话框中输入 **“请帮我创建一个 React 工程,高保真还原设计稿”**,并提供输出目录、设计稿链接([设计稿链接](https://www.figma.com/design/c0UBII8lURfxZIY8W6tSDR/Top-16-Websites-of-2024---Awwwards--Community-?node-id=30-8264&t=FB3Hohq2nsH7ZFts-4))及 Figma Token,Agent 即可引导您逐步完成网页生成。对于落地页(Landing Page)类页面,CodeRio 能达到 **高保真还原** 标准,精确还原图片与样式,并自动对卡片等组件进行 **复用封装**,生成的代码完全符合 **前端开发规范**
5555

56-
https://github.com/user-attachments/assets/a66dc680-f68d-4121-b416-aa6b778bd895
56+
57+
https://github.com/user-attachments/assets/43817e97-ffd2-40e3-9d33-78ee55b2ec2d
5758

5859
## 🚀 快速开始
5960

@@ -237,10 +238,6 @@ interface Protocol {
237238

238239
我们欢迎贡献!感谢所有贡献者!🎉
239240

240-
<a href="https://github.com/MigoXLab/coderio/graphs/contributors">
241-
<img src="https://contrib.rocks/image?repo=MigoXLab/coderio" />
242-
</a>
243-
244241
## 📄 许可证
245242

246243
Apache-2.0 © CodeRio 贡献者

0 commit comments

Comments
 (0)