Skip to content

Commit 76cdc3a

Browse files
committedJun 17, 2012
README: linked to API documentation
1 parent dc29047 commit 76cdc3a

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed
 

‎AppledocSettings.plist

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
<key>--company-id</key>
1515
<string>com.factisresearch</string>
1616
<key>--output</key>
17-
<string>doc</string>
17+
<string>docs</string>
1818
</dict>
1919
</plist>

‎README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,46 @@ FRLayeredNavigationController
22
=============================
33

44
FRLayeredNavigationController, an iOS container view controller with an API
5-
similar to UINavigationController. Read
6-
[my blog post about FRLayeredNavigationController](http://factisresearch.blogspot.de/2012/06/uis-for-hierachical-ipad-apps.html)
7-
to get an idea of what it is.
5+
similar to UINavigationController.
86

97
Official Project Home: https://github.com/weissi/FRLayeredNavigationController
108

11-
See below for instructions (and a screencast) on how to add
12-
FRLayeredNavigationController to your project.
9+
See below for documentation and instructions (including a screencast) on how
10+
to add FRLayeredNavigationController to your project.
1311

14-
If you have further questions, feel free to ask them!
12+
If you have further questions, feel free to [mail me](mailto:weiss@tux4u.de)!
1513

1614
©2012, [Johannes Weiß](mailto:weiss@tux4u.de) for
1715
[factis research GmbH](http://www.factisresearch.com).
1816

17+
18+
Documentation
19+
=============
20+
21+
- [The API documentation](http://weissi.github.com/FRLayeredNavigationController/docs/html/index.html)
22+
- [my blog post](http://factisresearch.blogspot.de/2012/06/uis-for-hierachical-ipad-apps.html)
23+
- [EuroCopa demo project](https://github.com/weissi/EuroCopaInfo)
24+
25+
1926
License
2027
=======
2128
It's all open source but you can use it in your commercial product free of
2229
charge. FRLayeredNavigationController is licensed under the terms of the
2330
Modified BSD License.
2431

32+
2533
Watch the demo videos
2634
=====================
2735
- http://youtu.be/v_tXD_mL05E
2836
- http://youtu.be/q66HX2td_uc
2937

38+
3039
Screenshots
3140
===========
3241
[![](https://github.com/weissi/FRLayeredNavigationController/raw/master/FRLayeredNavigationControllerScreenshot1.png)](https://github.com/weissi/FRLayeredNavigationController/raw/master/FRLayeredNavigationControllerScreenshot1.png)
3342
[![](https://github.com/weissi/FRLayeredNavigationController/raw/master/FRLayeredNavigationControllerScreenshot2.png)](https://github.com/weissi/FRLayeredNavigationController/raw/master/FRLayeredNavigationControllerScreenshot2.png)
3443

44+
3545
Adding FRLayeredNavigationController to your project
3646
====================================================
3747

@@ -73,3 +83,6 @@ http://youtu.be/k9bFAYtoenw .
7383
Just `#import "FRLayeredNavigationController/FRLayeredNavigation.h"`
7484
anywhere you want to use FRLayeredNavigationController in your project.
7585

86+
If you want to, you can install [appledoc](http://gentlebytes.com/appledoc/)
87+
and type `appledoc .` in FRLayeredNavigationController's root directory to
88+
install the API documentation in Xcode.

0 commit comments

Comments
 (0)
Please sign in to comment.