Skip to content

Commit

Permalink
Clarify readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
christophhagen committed Mar 14, 2024
1 parent a2a26f2 commit c65c171
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# iOS HealthDB Interface
# iOS Health Database Interface

A Swift interface to access health records of `healthdb.sqlite` files which have been recovered from iOS backups.
A Swift interface to access health records of `healthdb_secure.sqlite` files which have been recovered from iOS backups.

This library is a reverse-engineering effort to reconstruct Health data and allowing to access the SQLite database in a similar way to the actual `HKHealthStore` on iOS.
This library may can be useful when the original health data is lost and has to be recovered from a backup, or when a sample database is needed for testing.
This library is a reverse-engineering effort to reconstruct Health data from the SQLite database contained in an iOS Backup.
This library may can be useful when the original health data is lost and has to be recovered, or when a sample database is needed for testing.
And in general, it can be quite interesting to see the amount of data stored in Health.

## Working features

The framework allows access to a large part of the health records, but not all data types are fully supported.
New features may be added in the future, but there is also a chance that future updates may change the database layout and break a few things.

The following feature list refers to databases recovered with iOS 16 and iOS 17.

| Feature | Status | Comment |
|---|---|---|
[Category samples](#category-samples) | ✅ | 56/65 types supported |
Expand Down

0 comments on commit c65c171

Please sign in to comment.