Skip to content

Commit 32bc250

Browse files
committed
add some notes about contributing and perfer cocoapods
1 parent f854c8b commit 32bc250

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ authentication flow.
1818
Getting the sources is as easy as doing a:
1919
`git clone git://github.com/nxtbgthng/OAuth2Client.git`
2020

21+
### Adding the library to your project using CocoaPods
22+
[CocoaPods](http://cocoapods.org/) is a dependency manager for Xcode projects. It manages the above
23+
installation steps automatically.
24+
25+
In order to install the library this way add the following line to your `Podfile`:
26+
27+
```pod 'NXOAuth2Client', '~> 1.2.6'```
28+
29+
and run the following command `pod install`.
30+
31+
*Note:* CocoaPods is now the preferred way to integrate NXOAuth2Client into XCode
32+
2133
### Manually including the library in your Xcode project
2234

2335
#### iOS projects
@@ -46,15 +58,7 @@ to your targets *Link Binary With Libraries*)
4658
*Using the library as a framework in desktop applications is fairly untested. Please
4759
[report any issues](http://github.com/nxtbgthng/OAuth2Client/issues) and help in making the library better.*
4860

49-
### Adding the libary to your project using CocoaPods
50-
[CocoaPods](http://cocoapods.org/) is a dependency manager for Xcode projects. It manages the above
51-
installation steps automatically.
5261

53-
In order to install the library this way add the following line to your `Podfile`:
54-
55-
```pod 'NXOAuth2Client', '~> 1.2.2'```
56-
57-
and run the following command `pod install`.
5862

5963
## Using the OAuth2Client
6064

@@ -184,6 +188,12 @@ NSURLRequest *sigendRequest = [theRequest signedURLRequest];
184188
// Invoke the request with you preferd method
185189
</pre>
186190

191+
## Contributing & Pull Requests
192+
193+
Patches and pull requests are welcome! We are sorry if it takes a while to review them, but sooner or later we will get to yours.
194+
195+
Not that we are using the [git-flow](http://nvie.com/posts/a-successful-git-branching-model/) model of branching and releasing, so **please make pull requests against the develop branch** to make merging them easier.
196+
187197
## BSD License
188198

189199
Copyright © 2012, nxtbgthng GmbH

0 commit comments

Comments
 (0)