Android Library to display your changelog
Java
Clone or download

README.md

ChangeLog Library

ChangeLog Library provides an easy way to display a change log in your Android app.

Travis master: Build Status Travis dev: Build Status

Screen


Examples

If you would like, you can support my work, donating through the demo app.

For more examples and screenshots you can read this document:

Feature

ChangeLog Library provides a custom RecyclerView to display a change log through a xml file.

  • you can use it in Activities, Fragments, Dialogs
  • it works with a RecyclerView or a ListView
  • it supports html text markup as bold and italics
  • you can customize layout and behaviour
  • it supports multi language
  • it supports API 7+

Doc

See the customisation page: for more information.


Quick Start

ChangeLog Library is pushed to Maven Central as a AAR, so you just need to add the following dependency to your build.gradle.

dependencies {
    compile 'com.github.gabrielemariotti.changeloglib:changelog:2.1.0'
}

To build the library and demo locally you can see this page for more info.

ChangeLog

Usage

Implementing this library in your own apps is pretty simple.
First, add in your layout the ChangeLogRecyclerView that displays your changelog.

<?xml version="1.0" encoding="utf-8"?>
<it.gmariotti.changelibs.library.view.ChangeLogRecyclerView
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:layout_gravity="center" />

Then, you need a XML file with change log in res/raw folder. It automatically searches for res/raw/changelog.xml but you can customize filename.

<?xml version="1.0" encoding="utf-8"?>
<changelog bulletedList="true">

    <changelogversion versionName="1.0" changeDate="Aug 26,2013">
            <changelogtext>Initial release.</changelogtext>
    </changelogversion>

    <changelogversion versionName="0.9" changeDate="Aug 11,2013">
        <changelogtext>[b]New![/b] Add new attrs to customize header and row layout</changelogtext>
        <changelogtext>Fixed log while parsing </changelogtext>
        <changelogtext>Add support for html markup</changelogtext>
        <changelogtext>Add bullet point in </changelogtext>
        <changelogtext>Support for customized xml filename</changelogtext>
    </changelogversion>

</changelog>

Last, if you would like a multi language changelog, you just have to put the translated files changelog.xml in the appropriate folders res/raw-xx/.

Credits

Author: Gabriele Mariotti (gabri.mariotti@gmail.com)

Follow me on Google+ Follow me on Twitter Follow me on LinkedIn

License

Copyright 2013-2015 Gabriele Mariotti

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.