{"id":23635095,"url":"https://github.com/joncardasis/chronicle","last_synced_at":"2025-08-31T10:32:10.499Z","repository":{"id":73045136,"uuid":"108684054","full_name":"joncardasis/Chronicle","owner":"joncardasis","description":":watch: An iOS version compatibility checker. Force upgrades and recommend new versions.","archived":false,"fork":false,"pushed_at":"2017-10-30T16:52:41.000Z","size":187,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-10-20T20:49:30.983Z","etag":null,"topics":["force-upgrade","ios","json","swift4","version","versioning"],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joncardasis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-10-28T21:05:01.000Z","updated_at":"2023-10-20T20:51:06.065Z","dependencies_parsed_at":null,"dependency_job_id":"cc07bcfa-74ad-495c-a69e-13ef7cde4c0f","html_url":"https://github.com/joncardasis/Chronicle","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joncardasis%2FChronicle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joncardasis%2FChronicle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joncardasis%2FChronicle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joncardasis%2FChronicle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joncardasis","download_url":"https://codeload.github.com/joncardasis/Chronicle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231590304,"owners_count":18396921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["force-upgrade","ios","json","swift4","version","versioning"],"created_at":"2024-12-28T05:30:37.442Z","updated_at":"2024-12-28T05:30:55.254Z","avatar_url":"https://github.com/joncardasis.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"/Assets/Chronicle_Icon.png\" alt=\"Chronicle\" width=460px\u003e\n  \u003cp\u003e\u003cem\u003eAn iOS version checker\u003c/em\u003e\u003c/p\u003e\n  \u003cspan\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Swift-4-yellow.svg\" alt=\"Swift 4\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/platform-iOS-lightgray.svg\" alt=\"iOS Platform\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Carthage-✔-green.svg\" alt=\"Carthage Compatible\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\" alt=\"License\"\u003e\n  \u003c/span\u003e\n\u003c/div\u003e\n\n\u003eChronicle is a version compatibility checker for iOS applications.\n\n## How it works\n1. Host a properly formatted `json` file on your own server. Read more on formatting from the [Payload.md](Payload.md).\n2. In the `application:didFinishLaunchingWithOptions:` (or likewise) method of your app's AppDelegate check for version compliance and handle accordingly.\n\n## Example\n`Chronicle` provides 3 block callbacks which are all optional callbacks.\n\u003e (1) Minimum version found, (2) recommended version found, (3) error occurred.\n\n**Example**\n```Swift\nChronicle().checkForUpdates(from: url,\n      requiredVersion: { (version, isMinimumVersionSatisfied, notificationType) in\n        if notificationType == .once {\n          if !isMinimumVersionSatisfied {\n            print(\"\"\"\n                  Version \\(version.version) is available.\n                  You are required to download this version to continue using this application.\n                  Visit \\(version.storeUrl) to upgrade.\n                  \"\"\")\n          }\n        },\n        recommendedVersion: { (version, isMinimumVersionSatisfied, notificationType) in\n            if !isMinimumVersionSatisfied {\n              print(\"\"\"\n                    Version \\(version.version) is available!\n                    Attached message: \\(version.message)\n                    You should go and download it!\n                    \"\"\")\n            }\n\n        }) { (error) in\n            // Usually don't want to display anything to user at this point\n        }\n```\n\nCheck out the *ChronicleExample* build target for more.\n\n## Why Chronicle?\nObtaining current version info from the App Store directly is the *best* way to ensure your users are receiving notifications for app versions which actually exist.\n\nHowever, this project serves as a **force-upgrade** module for you to modify the required versions at any time via a simple json file.\n\nFor example, this is useful if an API breaking change was implemented and users who run versions less than 2.0 would be hitting incorrect endpoints.\n\n\n## JSON Payload Format\nA formatted JSON payload served via your own server.\n\n- See [ChronicleTests/JSON](ChronicleTests/JSON) for examples of the payload format.\n- See [Payload.md](Payload.md) for formatting requirements\n\n## License\nChronicle is available under the MIT license. See the LICENSE file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoncardasis%2Fchronicle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoncardasis%2Fchronicle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoncardasis%2Fchronicle/lists"}