Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Richi committed May 18, 2017
1 parent 1e2ff6e commit 274d3d3
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 4 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,54 @@
# FalconChangeLog
<br>
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

<br>

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
<?xml version="1.0" encoding="utf-8"?>
<changelog>
<release version="1.0" versioncode="2">
<change>Small layout change in the view item screen</change>
<change>Minor tweaks</change>
</release>
</changelog>
```

- 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.
Original file line number Diff line number Diff line change
Expand Up @@ -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; }"
Expand Down

0 comments on commit 274d3d3

Please sign in to comment.