From 5d2f7b4c8f76a1fb7cb8d3d0ad9ca7e6fcc6274a Mon Sep 17 00:00:00 2001
From: Victor Häggqvist <victor@snilius.com>
Date: Thu, 1 Jan 2015 16:28:17 +0100
Subject: init

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54c08de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+AboutIt
+=======
+A About-page creator
+
+#Sample
+A "complete" sample
+```java
+new AboutIt(this).app(R.string.app_name)
+    .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
+    .copyright("Example Business")
+    .libLicense("AboutIt", "Victor Häggqvist", L.AP2, "https://github.com/victorhaggqvist/aboutit")
+    .toTextView(R.id.about_text);
+```
+
+Just the dymanic version name and copyright year display
+```java
+new AboutIt(this).app("My App")
+        .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
+        .copyright("Example Business")
+        .toTextView(R.id.about_text);
+```
+
+The code for these samples are all in the sample app [here](aboutit-sample/src/main/java/com/snilius/aboutit/sample/MainActivity.java).
+
+|![sample](img/img1.png)|![sample](img/img2.png)|
+|--|--|
+|![sample](img/img3.png)|![sample](img/img4.png)|
+
+#License
+
+    Copyright 2014-2015 Victor Häggqvist
+
+    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.
-- 
cgit v1.2.3