diff --git a/README.md b/README.md index e69de29..79d9eac 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/assets/screenshot.png b/assets/screenshot.png new file mode 100644 index 0000000..93aa6d2 Binary files /dev/null and b/assets/screenshot.png differ