Updated readme with documentation.

fmscode · Apr 15, 2014 · ff108e9 · ff108e9
1 parent 8eadaf7
commit ff108e9
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,11 @@
 # BorderButton
+Subclass of UIButton that gives a colored border around a UIButton. The subclass takes the ```textColor``` attribute and creates a border with that color. When a user presses the button, it will change to be filled with the border color creating a solid color button.
+
+![](readmeassets/screenshot2.png)
+
+# Basic Usage
+To give a button a colored border set the class of the UIButton to ```BorderButton``` in your Storyboard or nib.
+
+![](readmeassets/screenshot1.png)
+
+If the buttons width and height are equal the class will add a circular border around the buttons frame. If the width and height are not equal, the border will be a rectangle with rounded edges.
diff --git a/readmeassets/screenshot1.png b/readmeassets/screenshot1.png
diff --git a/readmeassets/screenshot2.png b/readmeassets/screenshot2.png