Skip to content

Commit 92cf623

Browse files
committed
<fix>(doc): Updated documentation report
1 parent 4224bcb commit 92cf623

File tree

2 files changed

+4
-17
lines changed

2 files changed

+4
-17
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ BGCE Stream is a lightweight, browser-based audio streaming platform designed fo
6767
- **[v0.1.0 Release Notes](docs/releases/v0.1.0/README.md)** - Current MVP features
6868
- **[Backend README](backend/README.md)** - Backend-specific documentation
6969

70-
## 🏗️ Architecture
70+
<!-- ## 🏗️ Architecture
7171
7272
### Backend (Go)
7373
- **REST API** for room management
@@ -93,7 +93,7 @@ BGCE Stream is a lightweight, browser-based audio streaming platform designed fo
9393
- **Voice chats** - High-quality voice conversations
9494
- **Online rehearsals** - Practice sessions with band members
9595
- **Community meetings** - Small group discussions
96-
- **Gaming voice chat** - Low-latency audio for gaming
96+
- **Gaming voice chat** - Low-latency audio for gaming -->
9797

9898
## 🤝 Contributing
9999

@@ -136,7 +136,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
136136

137137
- **GitHub Issues** - Bug reports and feature requests
138138
- **GitHub Discussions** - Questions and general discussion
139-
- **Email** - [Contact maintainers](mailto:maintainers@example.com)
139+
- **Email** - [Contact maintainers](mailto:rahim.cse.diu@gmail.com)
140140

141141
## 🌟 Star History
142142

docs/releases/v0.1.0/README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,19 @@
11
# BGCE Stream v0.1.0 (Audio Rooms MVP)
22

33
## Goals
4-
- One-click room creation with a unique, shareable link
4+
- Room creation with a unique, shareable link
55
- Join by link and start streaming immediately
6-
- Browser-only audio processing toggles: AGC, Noise Suppression, Music Mode
7-
- Preserve audio richness using WebRTC/Opus tuning
8-
- Designed for small-to-medium "bhai-brother" groups
96

107
## Scope
118
- WebRTC P2P mesh (no SFU) with JSON signaling over `/ws`
129
- REST API for room lifecycle
1310
- No UI overhaul; minimal pages and controls
1411

1512
## API
16-
- POST `/api/rooms``{ roomId, joinUrl }`
17-
- GET `/api/rooms/{roomId}``{ exists: boolean }`
18-
- WS `/ws` → JSON messages: `join-room`, `offer`, `answer`, `candidate`, `leave`
1913

2014
## Signaling Messages (examples)
21-
```json
22-
{"type":"join-room","roomId":"abc","peerId":"peer-1"}
23-
{"type":"offer","roomId":"abc","peerId":"peer-1","targetPeerId":"peer-2","sdp":"..."}
24-
{"type":"candidate","roomId":"abc","peerId":"peer-1","targetPeerId":"peer-2","candidate":{}}
25-
```
2615

2716
## Audio Presets
28-
- Voice: echoCancellation, autoGainControl, noiseSuppression (all true)
29-
- Music: disable EC/AGC/NS, prefer stereo, higher bitrate
3017

3118
## Contributing
3219
See [Contributing Guide](../CONTRIBUTING.md) for detailed contribution workflow.

0 commit comments

Comments
 (0)