Skip to content

Commit

Permalink
Wrote README file
Browse files Browse the repository at this point in the history
  • Loading branch information
ChocoChipset committed Oct 1, 2013
1 parent f0ab54b commit 66c0edb
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,48 @@
Disposition
===========

Disposition is a set of functions to modify the attributes of a CGRect structure in an easier way.
Disposition is a set of functions handful when manipulating and setting the components of CGRect structures.

It's current reach is short, but tested and expected to grow over time.


Installation
-----------

1. Copy the ```Source/CGRect+Disposition.h``` header file to your project.
2. Show those CGRect structures who is the boss.


Use
---

1. The following function headers self-explain the reach of the library.
Note that the CGRect structure to modify should be passed by reference.

```obj-c
void CGRectSetSize(CGRect *rect, CGSize size);
void CGRectSetWidth(CGRect *rect, CGFloat width);
void CGRectSetHeight(CGRect *rect, CGFloat height);

void CGRectSetOrigin(CGRect *rect, CGPoint originPoint);
void CGRectSetX(CGRect *rect, CGFloat x);
void CGRectSetY(CGRect *rect, CGFloat y);
```
Contribution
-------------
Contribution is always welcomed. Create a pull request or raise an issue if you develop a new feature or enhancement or want to start discussing a topic concerning the library.
License
--------
Released under the MIT License.
Refer to the LICENSE file for more.
Author
-------
Hector Zarate ([@hecktorzr](http://twitter.com/hecktorzr))

0 comments on commit 66c0edb

Please sign in to comment.