Skip to content

Commit

Permalink
README: Fixing badges and final tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
AliSoftware committed May 3, 2014
1 parent 27fe063 commit 03f2e73
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
OHHTTPStubs
===========

[![Version](http://cocoapod-badges.herokuapp.com/v/OHHTTPStubs/badge.png)](http://cocoadocs.org/docsets/XCTest+OHHTTPStubSuiteCleanUp)
[![Platform](http://cocoapod-badges.herokuapp.com/p/OHHTTPStubs/badge.png)](http://cocoadocs.org/docsets/XCTest+OHHTTPStubSuiteCleanUp)
[![Version](http://cocoapod-badges.herokuapp.com/v/OHHTTPStubs/badge.png)](http://cocoadocs.org/docsets/OHHTTPStubs)
[![Platform](http://cocoapod-badges.herokuapp.com/p/OHHTTPStubs/badge.png)](http://cocoadocs.org/docsets/OHHTTPStubs)
[![Build Status](https://travis-ci.org/AliSoftware/OHHTTPStubs.png?branch=master)](https://travis-ci.org/AliSoftware/OHHTTPStubs)

`OHHTTPStubs` is a library designed to stub your network requests very easily. It can help you:
Expand All @@ -18,8 +18,8 @@ It works with `NSURLConnection`, new iOS7/OSX.9's `NSURLSession`, `AFNetworking`

# Documentation & Usage Examples

`OHHTTPStubs` headers are fully documented using Appledoc-like / Headerdoc-like comments in the header files. You can also [read the **online documentation** here](http://cocoadocs.org/docsets/OHHTTPStubs/):
[![Version](http://cocoapod-badges.herokuapp.com/v/OHHTTPStubs/badge.png)](http://cocoadocs.org/docsets/XCTest+OHHTTPStubSuiteCleanUp)
`OHHTTPStubs` headers are fully documented using Appledoc-like / Headerdoc-like comments in the header files. You can also [read the **online documentation** here](http://cocoadocs.org/docsets/OHHTTPStubs)
[![Version](http://cocoapod-badges.herokuapp.com/v/OHHTTPStubs/badge.png)](http://cocoadocs.org/docsets/OHHTTPStubs)

> Unfortunately macro documentation does not appear in the documentation generated by appledoc, so don't hesitate to take a look into `OHHTTPStubsResponse.h`, `OHHTTPStubsResponse+JSON.h` and `OHHTTPStubsResponse+HTTPMessage.h` too.
Expand All @@ -42,6 +42,12 @@ For a lot more examples, see the dedicated "[Usage Examples](https://github.com/

The wiki also contain [some articles that can help you get started](https://github.com/AliSoftware/OHHTTPStubs/wiki) with (and troubleshoot if needed) `OHHTTPStubs`.

# Compatibility

`OHHTTPStubs` is compatible with **iOS 5.0+** and **OSX 10.7+**.

`OHHTTPStubs` also works with iOS7's and OSX 10.9's `NSURLSession` mechanism.

# Special Considerations

## Using OHHTTPStubs in your Unit Tests
Expand All @@ -52,9 +58,7 @@ The wiki also contain [some articles that can help you get started](https://gith
* be sure to wait until the request has received its response before doing your assertions and letting the test case to finish (like for any asynchronous test). [see this wiki page for more info](https://github.com/AliSoftware/OHHTTPStubs/wiki/OHHTTPStubs-and-asynchronous-tests)


## OHHTTPStubs and NSURLSession

`OHHTTPSutbs` also works with iOS7's and OSX 10.9's `NSURLSession` mechanism.
## Automatic loading

In general, `OHHTTPStubs` is automatically enabled by default, both for:

Expand Down

0 comments on commit 03f2e73

Please sign in to comment.