diff --git a/README.md b/README.md index 2973b3b..ce85c1d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![DCO](https://github.com/superageapp/ios-core/actions/workflows/dco.yml/badge.svg)](https://github.com/superageapp/ios-core/actions/workflows/dco.yml) [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) -Evidence-first Fitness Age scoring for Swift apps. +Open-source Swift package for evidence-first Fitness Age (biological age) scoring in iOS, watchOS, macOS, and tvOS apps. It is the scoring engine behind the SuperAge app. SuperAgeCore is a Foundation-only Swift package that turns normalized fitness and wellness signals into a deterministic Fitness Age estimate, confidence score, and domain-level breakdown. It is built for host apps that already own health-data access and want the scoring engine to stay small, auditable, testable, and privacy-preserving. @@ -154,6 +154,15 @@ SuperAgeCore provides an informational fitness and wellness estimate only. It is Do not use SuperAgeCore outputs to diagnose, prevent, monitor, treat, or manage any disease or medical condition. Users should consult a qualified healthcare professional for health concerns, symptoms, or medical decisions. +## Useful Links + +- [SuperAge website](https://www.superage.app) — the biological age app for iPhone and Apple Watch, powered by SuperAgeCore +- [SuperAge on the App Store](https://apps.apple.com/app/id6751951815) — download the app for iOS +- [Methodology](Docs/METHODOLOGY.md) — Fitness Age domains, weights, scoring curves, confidence logic, and source anchors +- [Changelog](CHANGELOG.md) — release notes and expected result drift for every version +- [Contributing guide](CONTRIBUTING.md) — DCO signoff and the Algorithm RFC process +- [Issues](https://github.com/superageapp/ios-core/issues) — bug reports, questions, and Algorithm RFC proposals + ## Contributing Contributions are welcome under the rules in [CONTRIBUTING.md](CONTRIBUTING.md). All commits in pull requests must include a DCO signoff: