aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVictor Häggqvist <[email protected]>2015-07-25 01:25:37 +0200
committerVictor Häggqvist <[email protected]>2015-07-25 01:25:37 +0200
commit84659b2b377dbfdbbb8268e08549029ffa4950b3 (patch)
treecd5508bf02b2fda36fe2a31541fcb31f4f1298bd /README.md
parentf9484c86f4c2559893060e4c2eda3fa02c50e989 (diff)
feat: update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files 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
<img src="img/img3.png" alt="screenshot" width="300px" height="auto" />
<img src="img/img4.png" alt="screenshot" width="300px" height="auto" />
-#License
+## License
Copyright 2014-2015 Victor Häggqvist