Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gabriel committed Mar 28, 2011
1 parent 8f2d4d6 commit 29d04a0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
3 changes: 2 additions & 1 deletion Classes/YAJL.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
NSArray *arrayFromString = [JSONString yajl_JSON];
@endcode
@subsection Example2 To parse JSON from NSString with error and comments
@subsection Example2_1 To parse JSON from NSString with error and comments
@code
// With options and out error
Expand All @@ -87,6 +87,7 @@
@code
NSDictionary *dict = [NSDictionary dictionaryWithObject:@"value" forKey:@"key"];
NSString *JSONString = [dict yajl_JSONString];
// ==> {"key":"value"}
@endcode
@subsection Example4 To generate JSON from an object, beautified with custom indent
Expand Down
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,6 @@ The YAJL framework is an Objective-C framework for the [YAJL](http://lloyd.githu

- The online [API documentation](http://gabriel.github.com/yajl-objc/).

## Apps

YAJL framework is used by:

- [Yelp for iPhone/iPad](http://itunes.apple.com/us/app/yelp/id284910350?mt=8)
- Add your app here!

## Docset

Download and copy the YAJL.docset to `~/Library/Developer/Shared/Documentation/DocSets/YAJL.docset`

(You may need to restart XCode after copying the file.)

The documentation will appear within XCode:

![YAJL-Docset](http://rel.me.s3.amazonaws.com/yajl/images/docset.png)

## Install (Mac OS X)

### Installing in your project (Recommended)
Expand Down Expand Up @@ -61,6 +44,22 @@ The documentation will appear within XCode:
- Under `Framework Search Paths` make sure the (parent) directory to `YAJLiOS.framework` is listed.
- Under `Other Linker Flags` in your target, add `-ObjC` and `-all_load`

## Apps

YAJL framework is used by:

- [Yelp for iPhone/iPad](http://itunes.apple.com/us/app/yelp/id284910350?mt=8)
- Add your app here!

## Docset

Download and copy the YAJL.docset to `~/Library/Developer/Shared/Documentation/DocSets/YAJL.docset`

(You may need to restart XCode after copying the file.)

The documentation will appear within XCode:

![YAJL-Docset](http://rel.me.s3.amazonaws.com/yajl/images/docset.png)



0 comments on commit 29d04a0

Please sign in to comment.