{"id":21130329,"url":"https://github.com/cketti/ckChangeLog","last_synced_at":"2025-07-09T01:33:13.843Z","repository":{"id":6264262,"uuid":"7497350","full_name":"cketti/ckChangeLog","owner":"cketti","description":"ckChangeLog - An Android Library to display a Change Log","archived":false,"fork":false,"pushed_at":"2021-07-10T01:38:08.000Z","size":714,"stargazers_count":181,"open_issues_count":9,"forks_count":35,"subscribers_count":24,"default_branch":"master","last_synced_at":"2024-11-04T12:39:47.451Z","etag":null,"topics":["android","changelog","library"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cketti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"cketti"}},"created_at":"2013-01-08T07:18:58.000Z","updated_at":"2024-09-16T02:50:11.000Z","dependencies_parsed_at":"2022-09-26T16:20:29.158Z","dependency_job_id":null,"html_url":"https://github.com/cketti/ckChangeLog","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cketti%2FckChangeLog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cketti%2FckChangeLog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cketti%2FckChangeLog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cketti%2FckChangeLog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cketti","download_url":"https://codeload.github.com/cketti/ckChangeLog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225476370,"owners_count":17480215,"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":["android","changelog","library"],"created_at":"2024-11-20T05:32:36.592Z","updated_at":"2024-11-20T05:32:45.077Z","avatar_url":"https://github.com/cketti.png","language":"Java","funding_links":["https://github.com/sponsors/cketti"],"categories":["Libs"],"sub_categories":["\u003cA NAME=\"Widget\"\u003e\u003c/A\u003eWidget"],"readme":"# ckChangeLog - An Android Library to display a Change Log\n\n![Screenshot](screenshot_1.png)\n![Screenshot](screenshot_2.png)\n\nThis library provides an easy way to display a change log in your app.\n\n## Features\n\n * Displays changes since the last app update\n * Can display the complete change log history\n * Uses a simple XML file as source\n * Supports partial translations\n * Easily extendable to use something other than a dialog\n\nRepository at \u003chttps://github.com/cketti/ckChangeLog\u003e.\n\n\n## Usage\n\n1. Create the master change log in `res/xml/changelog_master.xml`. Formatted like this:\n\n  ```xml\n  \u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n  \u003cchangelog\u003e\n      \u003crelease version=\"1.1\" versioncode=\"11\" \u003e\n          \u003cchange\u003eTotally new and shiny version\u003c/change\u003e\n      \u003c/release\u003e\n      \u003crelease version=\"1.0\" versioncode=\"10\" \u003e\n          \u003cchange\u003eFixed: A bug fix\u003c/change\u003e\n          \u003cchange\u003eSome other changes I can't quite remember\u003c/change\u003e\n      \u003c/release\u003e\n      \u003crelease version=\"0.1\" versioncode=\"1\"\u003e\n          \u003cchange\u003eFirst release\u003c/change\u003e\n      \u003c/release\u003e\n  \u003c/changelog\u003e\n  ```\n\n2. Create translations of this `changelog_master.xml` file in files named `changelog.xml` under\nlanguage-specific versions of `res/xml/`, e.g. `res/xml-de/changelog.xml`.\n\n3. Display the change log dialog by putting the following code in your activity's `onCreate()` method:\n\n  ```java\n  ChangeLog cl = new ChangeLog(this);\n  if (cl.isFirstRun()) {\n      cl.getLogDialog().show();\n  }\n  ```\n\n## Include the library\n\nThe easiest way to add ckChangeLog to your project is via Gradle. Just add the following lines to your `build.gradle`:\n\n```groovy\ndependencies {\n    compile 'de.cketti.library.changelog:ckchangelog:1.2.2'\n}\n```\n\nTo tell Gradle where to find the library, make sure `build.gradle` also contains this:\n\n```groovy\nrepositories {\n    mavenCentral()\n}\n```\n\n## Customize labels\n\nIn order to change the labels of the dialog add the following items to your `strings.xml`:\n\n```\n  \u003cstring name=\"changelog_full_title\"\u003eChange Log\u003c/string\u003e\n  \u003cstring name=\"changelog_title\"\u003eWhat\\'s New\u003c/string\u003e\n  \u003cstring name=\"changelog_ok_button\"\u003eOK\u003c/string\u003e\n  \u003cstring name=\"changelog_show_full\"\u003eMore…\u003c/string\u003e\n```\n\n## Changelog\n\n### Version 1.2.2 (2015-01-09)\n* Added Ukrainian translation\n\n### Version 1.2.1\n* Add support for [AboutLibraries](https://github.com/mikepenz/AboutLibraries)\n* Fix build scripts so Javadoc JAR is properly created\n\n### Version 1.2.0\n* Made constant `DEFAULT_CSS` public\n* Changed internals to make it easier to read the change log from different sources\n* Added public method `getChangeLog(boolean)` that returns a list of `ReleaseItem`s\n* Changed minSdkVersion to 4\n* Switched to Gradle as build system\n* Added Greek, Spanish, Polish, and Russian translation\n\n### Version 1.1.0\n* Added method `skipLogDialog()`\n* Added Slovak and German translation\n\n### Version 1.0.0\n* **Breaking change!** Moved master translation from `res/raw/changelog.xml` to `res/xml/changelog_master.xml`\n* Added German translation of the sample app\n\n### Version 0.1\n* Initial release\n\n\n## Acknowledgments\n\nThis library is based on:\n* [android-change-log](http://code.google.com/p/android-change-log/) by Karsten Priegnitz\n* [Inscription](https://github.com/MartinvanZ/Inscription/) by [Martin van Zuilekom](https://github.com/MartinvanZ/)\n\nOther contributors:\n* [See here](https://github.com/cketti/ckChangeLog/graphs/contributors)\n* You? Please create pull requests against the [dev](https://github.com/cketti/ckChangeLog/tree/dev) branch\n\n\n## License\n\n    Copyright (C) 2012-2015 cketti and contributors\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcketti%2FckChangeLog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcketti%2FckChangeLog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcketti%2FckChangeLog/lists"}