Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
r0adkll committed Mar 9, 2015
1 parent 99410b3 commit e7ca1e1
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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}'
```
4 changes: 2 additions & 2 deletions library/library.iml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<module external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$/.." external.system.id="GRADLE" external.system.module.group="52Kit" external.system.module.version="unspecified" type="JAVA_MODULE" version="4">
<module external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$/.." external.system.id="GRADLE" external.system.module.group="android-52Kit" external.system.module.version="unspecified" type="JAVA_MODULE" version="4">
<component name="FacetManager">
<facet type="android-gradle" name="Android-Gradle">
<configuration>
Expand Down Expand Up @@ -84,7 +84,7 @@
<excludeFolder url="file://$MODULE_DIR$/build/outputs" />
<excludeFolder url="file://$MODULE_DIR$/build/tmp" />
</content>
<orderEntry type="jdk" jdkName="Android API 21 Platform (1)" jdkType="Android SDK" />
<orderEntry type="jdk" jdkName="Android API 21 Platform" jdkType="Android SDK" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" exported="" name="timber-2.7.1" level="project" />
<orderEntry type="library" exported="" name="guava-15.0" level="project" />
Expand Down

0 comments on commit e7ca1e1

Please sign in to comment.