diff --git a/README.md b/README.md index ffb1dee..9900dba 100644 --- a/README.md +++ b/README.md @@ -1 +1,54 @@ # FalconChangeLog +
+FalconChangeLog is an Android library to manage and show a changelog in your Android app. +"Inscription" was taken as the basis of the project, [This is the link of the repository.](https://github.com/MartinvanZ/Inscription) + +The goal is to improve and add functionality to the project + +
+ +Demo app on Google Play: +```groovy +To do soon +``` + +## How to include it in your project(Gradle): + +```groovy + compile 'com.github.bombe93:falconchangelog:1.0.1' +``` + + +## How to use it: + +- create a file under "rootProject/app/src/main/res/xml/changelog.xml" called "changelog.xml" and formatted like this: +```groovy + + + + Small layout change in the view item screen + Minor tweaks + + +``` + +- In the activity where you want to use it make the import: + ```groovy + import com.github.bombe93.falconchangelog.FalconChangeLog; + ``` +- Instantiate the class: + ```groovy + FalconChangeLog changelog; + changelog = new FalconChangeLog(YourActivity.this); + ``` +- And when you want to make the changelog look just to call the method like this: + ```groovy + changelog.show(); + ``` + + + + +##Contribute + +You can contribute without any problems. \ No newline at end of file diff --git a/falconchangelog/src/main/java/com/github/bombe93/falconchangelog/FalconChangeLog.java b/falconchangelog/src/main/java/com/github/bombe93/falconchangelog/FalconChangeLog.java index 9685e3f..bd9ecea 100644 --- a/falconchangelog/src/main/java/com/github/bombe93/falconchangelog/FalconChangeLog.java +++ b/falconchangelog/src/main/java/com/github/bombe93/falconchangelog/FalconChangeLog.java @@ -25,11 +25,9 @@ import java.text.SimpleDateFormat; import java.util.Date; -/** - * Class to show a change log dialog - */ + public class FalconChangeLog { - private static final String TAG = "ChangeLogDialog"; + private static final String TAG = "FalconChangeLog"; private final Context mContext; private String mStyle = "h1 { margin-left: 0px; font-size: 12pt; }"