diff --git a/README.md b/README.md index 79ed307..53b756f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# android-about-box -Modern About Box for an Android App +[![Circle CI](https://circleci.com/gh/eggheadgames/android-about-box.svg?style=svg)](https://circleci.com/gh/eggheadgames/android-about-box) +[![Release](https://jitpack.io/v/eggheadgames/android-about-box.svg)](https://jitpack.io/#eggheadgames/android-about-box) + +# About Box +A modern About Box for an Android App + +### Easily display the common items of an About Box in a modern Android friendly way + +## About + +Android About Box is configured with a set of (mostly) strings for the company name, twitter and Facebook accounts, website, and filenames to html files for help files, privacy policy etc. + +When triggered from a menu item, it will display the app name, icon and version, provide links to contact support, leave a review, share the app, go to other apps by the same company in the app store -- as well as links to Facebook etc. +