From ec9a3c8dbe5877ed6ffd9ba16805f8781a9df9c8 Mon Sep 17 00:00:00 2001 From: Koishi Date: Mon, 26 Jan 2026 20:52:47 +0800 Subject: [PATCH] docs: update readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 13affcef..6786a9e0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # MomShell +[![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](LICENSE) +[![Python 3.11](https://img.shields.io/badge/Python-3.11-3776AB?logo=python&logoColor=white)](https://www.python.org/) +[![Node.js 22](https://img.shields.io/badge/Node.js-22-339933?logo=node.js&logoColor=white)](https://nodejs.org/) +[![FastAPI](https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/) +[![Next.js](https://img.shields.io/badge/Next.js-000000?logo=next.js&logoColor=white)](https://nextjs.org/) + A warm, AI-powered companion for postpartum recovery — offering emotional support, exercise coaching, and a caring community for new mothers. ## Features @@ -236,6 +242,15 @@ See `.env.example` for all available configuration options. - Client sends video frames, server returns keypoints - Skeleton drawn on client side for smooth 20+ FPS experience +## Contributing + +We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) for details on: + +- Development environment setup +- Code standards and quality checks +- Branch management and PR process +- Commit message conventions + ## License This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.