From db67a8e996e5acdf4b5aa2fa65c563e2e60f0e05 Mon Sep 17 00:00:00 2001 From: Mattt Thompson Date: Tue, 22 Nov 2011 10:40:04 -0600 Subject: [PATCH] Adding note about Wiki articles Adding credit to Alan Defibaugh for the AFNetworking logo Minor edits --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 04fce43..9726457 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,15 @@ ## A delightful iOS and OS X networking framework ### There's a lot to be said for a networking library that you can wrap your head around. API design matters, too. Code at its best is poetry, and should be designed to delight (but never surprise). -AFNetworking is a delightful networking library for iOS and Mac OS X. It's built on top of familiar Foundation network classes, using `NSOperation` for scheduling and concurrency, and blocks for convenience and flexibility. It's designed to make common tasks easy, and to make complex tasks simple. +AFNetworking is a delightful networking library for iOS and Mac OS X. It's built on top of familiar Foundation network classes, using `NSOperation` for scheduling and concurrency, and blocks for convenience and flexibility. It's designed to make common tasks easy, and to make complex tasks simple. ## Documentation -Online documentation is available at http://gowalla.github.com/AFNetworking/. +API documentation is available at [http://afnetworking.org/Documentation](http://afnetworking.org/Documentation). -To install the docset directly into your local Xcode organizer, first [install `appledoc`](https://github.com/tomaz/appledoc), and then clone this project and run `appledoc -p AFNetworking -c "Gowalla" --company-id com.gowalla AFNetworking/*.h` +To install the API docset directly into your local Xcode organizer, first [install `appledoc`](https://github.com/tomaz/appledoc), and then clone this project and run `appledoc -p AFNetworking -c "Alamofire" --company-id com.alamofire AFNetworking/*.h` + +If you're looking for something more human-friendly, or more conceptual in nature, be sure to [check out the Wiki](https://github.com/AFNetworking/AFNetworking/wiki). ## Example Projects @@ -140,6 +142,8 @@ AFNetworking was created by [Scott Raymond](https://github.com/sco/) and [Mattt [TTTLocationFormatter](), used in the example project, is part of [FormatterKit](https://github.com/mattt/FormatterKit), created by [Mattt Thompson](https://github.com/mattt/). +AFNetworking's logo was designed by the amazingly-talented [Alan Defibaugh](http://www.alandefibaugh.com/). + ## Contact Mattt Thompson