From 84659b2b377dbfdbbb8268e08549029ffa4950b3 Mon Sep 17 00:00:00 2001 From: Victor Häggqvist Date: Sat, 25 Jul 2015 01:25:37 +0200 Subject: feat: update readme --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3375b84..a44c461 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -AboutIt -======= +# AboutIt A About-page creator -#Sample -A "complete" sample +## Install +From Maven Central [![](https://img.shields.io/maven-central/v/com.snilius.aboutit/aboutit.svg)](http://mvnrepository.com/artifact/com.snilius.aboutit/aboutit) + + compile 'com.snilius.aboutit:aboutit:VERSION@aar' + +## Sample +A complete sample ```java new AboutIt(this).app(R.string.app_name) .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME) @@ -12,7 +16,7 @@ new AboutIt(this).app(R.string.app_name) .toTextView(R.id.about_text); ``` -Just the dymanic version name and copyright year display +Just the dynamic version name and copyright year display ```java new AboutIt(this).app("My App") .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME) @@ -27,7 +31,7 @@ The code for these samples are all in the sample app [here](aboutit-sample/src/m screenshot screenshot -#License +## License Copyright 2014-2015 Victor Häggqvist -- cgit v1.2.3