📚 docs: add project README and screenshot

2026-07-15 14:27:48 +00:00 · 2026-06-30 21:45:32 +07:00
parent 06ee048afc
commit c93bfdccec
2 changed files with 36 additions and 0 deletions
@@ -0,0 +1,36 @@
+# 🔵 VRC Circle
+
+An unofficial VRChat desktop hub and launcher built with Electron, React, and the community VRChat SDK.
+
+![VRC Circle screenshot](assets/screenshot.png)
+
+> [!WARNING]
+> VRC Circle is in heavy development. Expect bugs, incomplete features, breaking changes, and rough edges. Use it at your own risk.
+
+## ✨ Features
+
+- Accounts
+- Friends and presence
+- Worlds, avatars, groups, and profiles
+- Favorites
+- Gallery
+- Launcher tools
+- Enhancements
+- Themes and localization
+- Unity project tools (TODO)
+
+## 🛠️ Development
+
+```bash
+pnpm install
+pnpm dev
+pnpm build
+```
+
+## 📜 VRChat Guidelines
+
+Use VRC Circle responsibly and follow VRChat's [Creator Guidelines](https://hello.vrchat.com/creator-guidelines), Community Guidelines, and Terms of Use.
+
+## ⚠️ Disclaimer
+
+VRC Circle is not affiliated with, endorsed by, or sponsored by VRChat Inc.