diff --git a/README.md b/README.md index 5026263..85af4b8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,42 @@ # 52Kit +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.52inc/52Kit/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.52inc/52Kit) Library that acts as the foundation to building our android applications. ## Sections ### Preferences -This library includes several dependency injection ready Preference helper classes and an AES-256 Encryption wrapper for SharedPreferences. +This library includes several dependency injection ready Preference helper classes and an AES-256 Encryption wrapper for SharedPreferences. See [here](https://github.com/52inc/android-52Kit/tree/master/library/src/main/java/com/ftinc/kit/preferences) for further documentation. +### Utilities +This library also includes a handful of utility classes that contain convienence functions for a variety of tasks. You can view the source [here](https://github.com/52inc/android-52Kit/tree/master/library/src/main/java/com/ftinc/kit/util) which includes these utilities: + +* `Utils.java` - A generic utility class that contains basic helper functions +* `BuildUtils.java` - A utility class with functions that focus around the build of the device, i.e. the OS. +* `ColorUtils.java` - A utility class that deals with colors +* `FileUtils.java` - A utility class that contains helper functions for dealing with file transactions +* `IntentUtils.java` - A utility class that provides a lot of `Intent` creating functions +* `TimeUtils.java` - A utility class for functions that deal with time and formatting time +* `UIUtils.java` - A utility class for helper functions that deal with the UI and views +* `FormatUtils.java` - A utility class for formatting text and generating hash strings + +### Widgets + +See [here](https://github.com/52inc/android-52Kit/tree/master/library/src/main/java/com/ftinc/kit/widget) for a list of pre-built widgets and views. + +### Font + +See [here](https://github.com/52inc/android-52Kit/tree/master/library/src/main/java/com/ftinc/kit/font) for a Utility, FontLoader, that can easily apply Roboto typefaces to textviews. + +### Adapters + +See [here](https://github.com/52inc/android-52Kit/tree/master/library/src/main/java/com/ftinc/kit/adapter) for Subclassed List and Recycler Adapters that make it easier to build list views + +## Including in your project + +Include this line in your gradle build file: + +``` +compile 'com.52inc:kit:{current_version}' +``` \ No newline at end of file diff --git a/library/library.iml b/library/library.iml index d2dd40c..752c5b9 100644 --- a/library/library.iml +++ b/library/library.iml @@ -1,5 +1,5 @@ - + @@ -84,7 +84,7 @@ - +