Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielemariotti/changeloglib
Android Library to display your changelog
https://github.com/gabrielemariotti/changeloglib
Last synced: 1 day ago
JSON representation
Android Library to display your changelog
- Host: GitHub
- URL: https://github.com/gabrielemariotti/changeloglib
- Owner: gabrielemariotti
- Created: 2013-08-29T10:18:39.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-16T07:28:01.000Z (almost 6 years ago)
- Last Synced: 2025-01-13T05:01:49.687Z (8 days ago)
- Language: Java
- Homepage:
- Size: 3.52 MB
- Stars: 848
- Watchers: 37
- Forks: 137
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-android-ui - https://github.com/gabrielemariotti/changeloglib
README
# ChangeLog Library
ChangeLog Library provides an easy way to display a change log in your Android app.
Travis master: [](https://travis-ci.org/gabrielemariotti/changeloglib)
Travis dev: [](https://travis-ci.org/gabrielemariotti/changeloglib)
---
## Examples
* **Sample** application: The demo is a showcase of the functionality of the library.
[](https://play.google.com/store/apps/details?id=it.gmariotti.changelog.demo)
* Browse the [source code of the sample application](/ChangeLogDemo) for a complete example of use.
**If you would like, you can support my work, donating through the demo app.**
For more examples and screenshots you can read this [document:](/ChangeLogDemo/README.md)
## 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:](/doc/CUSTOMIZATION.md) 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`.
``` groovy
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](/doc/BUILD.md).
## ChangeLog
* [Changelog:](CHANGELOG.md) A complete changelog
## Usage
Implementing this library in your own apps is pretty simple.
First, add in your layout the `ChangeLogRecyclerView ` that displays your changelog.
``` xml
```
Then, you need a XML file with change log in `res/raw` folder.
It automatically searches for [`res/raw/changelog.xml`](/ChangeLogLibrary/src/main/res/raw/changelog.xml) but you can customize filename.
``` xml
Initial release.
[b]New![/b] Add new attrs to customize header and row layout
Fixed log while parsing
Add support for html markup
Add bullet point in
Support for customized xml filename
```
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 ([email protected])
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.