Skip to content

Commit b15e2b7

Browse files
committed
docs: Update installation instructions and enhance API documentation in README
1 parent 94f0a60 commit b15e2b7

File tree

2 files changed

+613
-54
lines changed

2 files changed

+613
-54
lines changed

README.md

Lines changed: 67 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,25 @@ WiFi DensePose consists of several key components working together:
9090

9191
### Using pip (Recommended)
9292

93+
WiFi-DensePose is now available on PyPI for easy installation:
94+
9395
```bash
96+
# Install the latest stable version
9497
pip install wifi-densepose
98+
99+
# Install with specific version
100+
pip install wifi-densepose==1.0.0
101+
102+
# Install with optional dependencies
103+
pip install wifi-densepose[gpu] # For GPU acceleration
104+
pip install wifi-densepose[dev] # For development
105+
pip install wifi-densepose[all] # All optional dependencies
95106
```
96107

97108
### From Source
98109

99110
```bash
100-
git clone https://github.com/your-org/wifi-densepose.git
111+
git clone https://github.com/ruvnet/wifi-densepose.git
101112
cd wifi-densepose
102113
pip install -r requirements.txt
103114
pip install -e .
@@ -106,8 +117,8 @@ pip install -e .
106117
### Using Docker
107118

108119
```bash
109-
docker pull your-org/wifi-densepose:latest
110-
docker run -p 8000:8000 your-org/wifi-densepose:latest
120+
docker pull ruvnet/wifi-densepose:latest
121+
docker run -p 8000:8000 ruvnet/wifi-densepose:latest
111122
```
112123

113124
### System Requirements
@@ -188,74 +199,71 @@ async def stream_poses():
188199
asyncio.run(stream_poses())
189200
```
190201

191-
## 📚 API Documentation
202+
## 📚 Documentation
203+
204+
Comprehensive documentation is available to help you get started and make the most of WiFi-DensePose:
205+
206+
### 📖 Core Documentation
192207

193-
### REST API Endpoints
208+
- **[User Guide](docs/user_guide.md)** - Complete guide covering installation, setup, basic usage, and examples
209+
- **[API Reference](docs/api_reference.md)** - Detailed documentation of all public classes, methods, and endpoints
210+
- **[Deployment Guide](docs/deployment.md)** - Production deployment, Docker setup, Kubernetes, and scaling strategies
211+
- **[Troubleshooting Guide](docs/troubleshooting.md)** - Common issues, solutions, and diagnostic procedures
194212

195-
The system provides a comprehensive REST API for all operations:
213+
### 🚀 Quick Links
196214

197-
#### Pose Estimation
198-
- `GET /api/v1/pose/latest` - Get latest pose data
199-
- `GET /api/v1/pose/history` - Get historical pose data
200-
- `GET /api/v1/pose/tracking/{track_id}` - Get person tracking data
201-
- `POST /api/v1/pose/process` - Submit CSI data for processing
215+
- **Interactive API Docs**: http://localhost:8000/docs (when running)
216+
- **Health Check**: http://localhost:8000/api/v1/health
217+
- **Latest Poses**: http://localhost:8000/api/v1/pose/latest
218+
- **System Status**: http://localhost:8000/api/v1/system/status
202219

203-
#### System Management
204-
- `POST /api/v1/system/start` - Start the pose estimation system
205-
- `POST /api/v1/system/stop` - Stop the system
206-
- `GET /api/v1/system/status` - Get system status
207-
- `POST /api/v1/system/restart` - Restart the system
220+
### 📋 API Overview
208221

209-
#### Configuration
210-
- `GET /api/v1/config` - Get current configuration
211-
- `PUT /api/v1/config` - Update configuration
212-
- `GET /api/v1/config/schema` - Get configuration schema
222+
The system provides a comprehensive REST API and WebSocket streaming:
213223

214-
#### Analytics
215-
- `GET /api/v1/analytics/summary` - Get analytics summary
216-
- `GET /api/v1/analytics/events` - Get activity events (falls, alerts)
217-
- `GET /api/v1/analytics/occupancy` - Get occupancy data
224+
#### Key REST Endpoints
225+
```bash
226+
# Pose estimation
227+
GET /api/v1/pose/latest # Get latest pose data
228+
GET /api/v1/pose/history # Get historical data
229+
GET /api/v1/pose/zones/{zone_id} # Get zone-specific data
218230

219-
### WebSocket API
231+
# System management
232+
GET /api/v1/system/status # System health and status
233+
POST /api/v1/system/calibrate # Calibrate environment
234+
GET /api/v1/analytics/summary # Analytics dashboard data
235+
```
220236

221-
Real-time streaming endpoints:
237+
#### WebSocket Streaming
238+
```javascript
239+
// Real-time pose data
240+
ws://localhost:8000/ws/pose/stream
222241

223-
- `ws://localhost:8000/ws/pose/stream` - Real-time pose data stream
224-
- `ws://localhost:8000/ws/analytics/events` - Real-time analytics events
225-
- `ws://localhost:8000/ws/system/status` - Real-time system status
242+
// Analytics events (falls, alerts)
243+
ws://localhost:8000/ws/analytics/events
226244

227-
### Python SDK Examples
245+
// System status updates
246+
ws://localhost:8000/ws/system/status
247+
```
228248

249+
#### Python SDK Quick Example
229250
```python
230251
from wifi_densepose import WiFiDensePoseClient
231252

232253
# Initialize client
233254
client = WiFiDensePoseClient(base_url="http://localhost:8000")
234255

235-
# Get latest poses
256+
# Get latest poses with confidence filtering
236257
poses = client.get_latest_poses(min_confidence=0.7)
258+
print(f"Detected {len(poses)} persons")
237259

238-
# Get historical data
239-
history = client.get_pose_history(
240-
start_time="2025-01-07T00:00:00Z",
241-
end_time="2025-01-07T23:59:59Z"
242-
)
243-
244-
# Get analytics
245-
analytics = client.get_analytics_summary(
246-
start_time="2025-01-07T00:00:00Z",
247-
end_time="2025-01-07T23:59:59Z"
248-
)
249-
250-
# Configure system
251-
client.update_config({
252-
"detection": {
253-
"confidence_threshold": 0.8,
254-
"max_persons": 5
255-
}
256-
})
260+
# Get zone occupancy
261+
occupancy = client.get_zone_occupancy("living_room")
262+
print(f"Living room occupancy: {occupancy.person_count}")
257263
```
258264

265+
For complete API documentation with examples, see the [API Reference Guide](docs/api_reference.md).
266+
259267
## 🔧 Hardware Setup
260268

261269
### Supported Hardware
@@ -773,7 +781,7 @@ We welcome contributions to WiFi DensePose! Please follow these guidelines:
773781

774782
```bash
775783
# Clone the repository
776-
git clone https://github.com/your-org/wifi-densepose.git
784+
git clone https://github.com/ruvnet/wifi-densepose.git
777785
cd wifi-densepose
778786

779787
# Create virtual environment
@@ -881,9 +889,14 @@ SOFTWARE.
881889

882890
## 📞 Support
883891

884-
- **Documentation**: [https://docs.wifi-densepose.com](https://docs.wifi-densepose.com)
885-
- **Issues**: [GitHub Issues](https://github.com/your-org/wifi-densepose/issues)
886-
- **Discussions**: [GitHub Discussions](https://github.com/your-org/wifi-densepose/discussions)
892+
- **Documentation**:
893+
- [User Guide](docs/user_guide.md) - Complete setup and usage guide
894+
- [API Reference](docs/api_reference.md) - Detailed API documentation
895+
- [Deployment Guide](docs/deployment.md) - Production deployment instructions
896+
- [Troubleshooting Guide](docs/troubleshooting.md) - Common issues and solutions
897+
- **Issues**: [GitHub Issues](https://github.com/ruvnet/wifi-densepose/issues)
898+
- **Discussions**: [GitHub Discussions](https://github.com/ruvnet/wifi-densepose/discussions)
899+
- **PyPI Package**: [https://pypi.org/project/wifi-densepose/](https://pypi.org/project/wifi-densepose/)
887900
- **Email**: support@wifi-densepose.com
888901
- **Discord**: [Join our community](https://discord.gg/wifi-densepose)
889902

0 commit comments

Comments
 (0)