|
1 | 1 | TapkuLibrary |
2 | 2 | ============ |
3 | | -TapkuLibrary is an open source iOS framework built on Cocoa and UIKit intended for broad use in applications. If you really like the framework, [drop me a line](http://devinsheaven.com/about#contact), I'd love to hear about it. Many thanks to those who have contributed to the project. |
| 3 | +TapkuLibrary is an open source iOS library built on Cocoa and UIKit intended for broad use in applications. If you're looking to see what the library can do, check out the demo project included. Some major components include coverflow, calendar grid, network requests and progress indicators. |
4 | 4 |
|
5 | 5 |
|
6 | | -### Classes |
7 | 6 |
|
8 | | -* [TKHTTPRequest](https://github.com/devinross/tapkulibrary/blob/master/src/TapkuLibrary/TKHTTPRequest.h) |
9 | | -* [TKCoverflowView](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKCoverflowView.h) |
10 | | -* [TKCalendarMonthView](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKCalendarMonthView.h) |
11 | | -* [TKImageCenter](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKImageCenter.h) |
12 | | -* [TKAlertCenter](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKAlertCenter.h) |
13 | | -* [TKProgressAlertView](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKProgressAlertView.h) |
14 | | -* [TKLoadingView](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKLoadingView.h) |
15 | | -* [TKButtonCell](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKButtonCell.h) |
16 | | -* [TKLabelCell](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKLabelCell.h) |
17 | | -* [TKEmptyView](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKEmptyView.h) |
18 | | -* [TKWindow](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/TKWindow.h) |
19 | | -* [(and more)](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary) |
| 7 | +## Documentation |
| 8 | +Included in the repository is a .docset bundle with all documentation for the library. Place the bundle in the ~/Library/Developer/Shared/Documentation/DocSets directory |
20 | 9 |
|
21 | | -### Categories |
| 10 | +## Adding Tapku To Your Project |
22 | 11 |
|
23 | | -* [NSString](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/NSString+TKCategory.h) |
24 | | -* [NSDate](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/NSDate+TKCategory.h) |
25 | | -* [NSArray](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/NSArray+TKCategory.h) |
26 | | -* [UIView](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/UIView+TKCategory.h) |
27 | | -* [UIImage](https://github.com/devinross/tapkulibrary/tree/master/src/TapkuLibrary/UIImage+TKCategory.h) |
| 12 | +Instructions on adding tapku library can be [found here](https://github.com/devinross/tapkulibrary/wiki/Adding-Tapku-to-Your-Project-in-XCode-4). For additional help, check out the demo project. |
28 | 13 |
|
29 | 14 |
|
30 | | -## Adding Tapku To Your Project / [Documentation](http://wiki.github.com/devinross/tapkulibrary/) |
31 | | - |
32 | | -The best place to start is by downloading the source and trying out the demo app. The demo project gives a brief overview of the functionality of the framework. Instructions on adding the framework in your own project for [XCode 3](https://github.com/devinross/tapkulibrary/wiki/Adding-Tapku-to-Your-Project-in-XCode-3) & [XCode 4](https://github.com/devinross/tapkulibrary/wiki/Adding-Tapku-to-Your-Project-in-XCode-4) and documentation, can be found on the [wiki](http://wiki.github.com/devinross/tapkulibrary/). |
33 | | - |
34 | | - |
35 | | -### Links |
36 | | - |
37 | | -* [Creator's Homepage](http://devinsheaven.com) |
38 | | -* [Framework Landing Page](http://tapku.com) |
39 | | -* [Documentation](http://wiki.github.com/devinross/tapkulibrary/) |
| 15 | +Follow me on twitter, [@devin_ross](http://twitter.com/devin_ross). |
0 commit comments