precise-time-ntp/docs/README.md

⏰ Simple NTP time sync for Node.js - Auto-drift, WebSocket & HTML clocks

# 📚 precise-time-ntp Documentation

## 🚀 Getting Started

- **[Quick Start Guide](quick-start.md)** - Get up and running in 5 minutes
- **[Complete API Reference](api-reference.md)** - All methods and configuration options
- **[WebSocket Integration](websocket-guide.md)** - Real-time HTML clocks with step-by-step examples
- **[FAQ](faq.md)** - Common questions and troubleshooting

## ⚡ Advanced Features

- **[Smooth Correction](smooth-correction.md)** - Avoid jarring time jumps with gradual adjustments

## 💡 Example Use Cases

| Use Case | Description |
|----------|-------------|
| **Real-time web apps** | Synchronized clocks and timers in browsers |
| **Logging systems** | Precise timestamps for events and debugging |
| **Performance monitoring** | Accurate time measurements and benchmarks |
| **Gaming applications** | Synchronized game timers and events |
| **Financial systems** | Precise transaction timestamps |

## 🏃‍♂️ Quick Test Drive

Try these examples from your project root:

```bash
# Basic synchronization
npm run basic

# WebSocket HTML clock  
npm run websocket
# Then open examples/clock.html in your browser

# Auto-sync example
npm run auto-sync
```

## 📖 Full Documentation

For the complete API documentation and advanced usage patterns, see the individual guides above.