mirror of
https://github.com/acamarata/qibla-dart.git
synced 2026-07-01 11:24:27 +00:00
cc3c227d2d
* chore: surface-area parity audit vs qibla-js, bump to v1.0.1 Full gap analysis: qibla-dart already matches @acamarata/qibla on all five public functions (qiblaAngle, compassDir, compassName, qiblaGreatCircle, distanceKm) and three constants (kaabaLat, kaabaLng, earthRadiusKm). No runtime gaps found; 48/48 tests pass unchanged. Patch bump documents the audit and closes T-E10-01 (Mega Phase 1). * docs: add CHANGELOG.md for v1.0.1 release * chore: polish pubspec, add wiki docs
29 lines
832 B
Markdown
29 lines
832 B
Markdown
# qibla
|
|
|
|
Qibla direction, great-circle path, and haversine distance for Dart and Flutter. Computes the bearing to the Ka'bah from any point on Earth. Pure math, zero dependencies.
|
|
|
|
## Install
|
|
|
|
```yaml
|
|
dependencies:
|
|
qibla: ^1.0.1
|
|
```
|
|
|
|
```dart
|
|
import 'package:qibla/qibla.dart';
|
|
|
|
final bearing = qiblaAngle(40.7128, -74.006);
|
|
print(bearing); // ~58.48
|
|
print(compassDir(bearing)); // NE
|
|
|
|
final km = distanceKm(40.7128, -74.006, kaabaLat, kaabaLng);
|
|
print(km); // ~9634
|
|
```
|
|
|
|
## Contents
|
|
|
|
- [Quickstart Guide](guides/quickstart) — install, first call, compass directions
|
|
- [Advanced Usage](guides/advanced) — great-circle paths, custom interpolation
|
|
- [API Reference](API-Reference) — full function and constant reference
|
|
- [Examples](examples/basic-usage) — real-world snippets
|
|
- [Contributing](CONTRIBUTING)
|