Skip to content

Commit

Permalink
Updated README with the new version information
Browse files Browse the repository at this point in the history
  • Loading branch information
rhodgkins committed Jun 9, 2016
1 parent 20e0501 commit 5d0b066
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,36 @@ Swift enum wrapper for easier handling of HTTP status codes.

The purpose of this library is to improve to clarify of code and remove the need for checking of status codes as numbers (`==200`), or as a range of values (`== 2xx`) - instead replacing it with descriptive enums.

All the [RF2616](http://www.ietf.org/rfc/rfc2616.txt) standard status codes are supported with a few added ones from the [Wikipedia page](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes).
All the [RF2616](http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) standard status codes are supported with a few added ones from the [Wikipedia page](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes).

As of version 3.0.0 of this framework, the list of status codes are directly generated from a [online IANA CSV](http://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv). The [HTML page](http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) has a last updated field, and this is also mirrored in the header comments to identify which version this framework is currently using.<br/>
If this library is out of date compared to this page please open an issue and I will update the list.

## Usage

With Carthage:
### Carthage

`Cartfile`:
```ogdl
github "rhodgkins/SwiftHTTPStatusCodes" ~> 2.0
github "rhodgkins/SwiftHTTPStatusCodes" ~> 3.0
```
Source code:
```swift
import HTTPStatusCodes
```

With CocoaPods:
### CocoaPods
`Podfile`:
```ruby
pod 'HTTPStatusCodes', '~> 2.0.0'
pod 'HTTPStatusCodes', '~> 3.0.0'
```
Source code:

In your source file:
```swift
import HTTPStatusCodes
```

### Manually
Or drop in the Swift files inside the [`Sources folder`](https://github.com/rhodgkins/SwiftHTTPStatusCodes/tree/master/Sources) into your project.

## Helper methods
Expand Down

0 comments on commit 5d0b066

Please sign in to comment.