README.md in pesapal-0.0.1 vs README.md in pesapal-0.0.2

- old
+ new

@@ -1,19 +1,23 @@ Pesapal RubyGem =============== +<a href="http://badge.fury.io/rb/pesapal"><img src="https://badge.fury.io/rb/pesapal@2x.png" alt="Gem Version" height="18"></a> + Make authenticated Pesapal API calls without the fuss! Handles all the [oAuth stuff][1] abstracting any direct interaction with the API endpoints so that you can focus on what matters. _Building awesome_. This gem is work in progress. At the moment, the only functionality built-in is posting an order i.e. fetching the URL that is required to display the post- order iframe. Everything else should be easy to do as the groundwork has already been laid. If you are [feeling generous and want to contribute, feel free][9]. -Submit [issues and requests here][6]. The gem should be [up on RubyGems.org][7]. +Submit [issues and requests here][6] and [find all the releases here][12]. +The gem should be [up on RubyGems.org][7] and it's [accompanying RubyDoc reference][13] here. + _Ps: No 3rd party oAuth library dependencies, it handles all the oAuth flows on it's own so it's light on your app._ Installation @@ -55,10 +59,16 @@ pesapal.credentials = { :consumer_key => '<YOUR_CONSUMER_KEY>', :consumer_secret => '<YOUR_CONSUMER_SECRET>' } ``` +By default the callback is set to `http://0.0.0.0:3000/pesapal/callback` on instantiation but you can easily set it to whatever works for you as shown below. + +```ruby +pesapal.callback_url = 'WHATEVER_URL_YOU_WANT' +``` + ### Post Order ### Once you've set up the credentials, set up the order details in a hash as shown in the example below ... all keys **MUST** be present. If there's one that you wish to ignore just leave it with a blank string but make sure it's included @@ -106,14 +116,26 @@ * [Developing a RubyGem using Bundler][2] * [Make your own gem][3] * [Pesapal API Reference (Official)][4] * [Pesapal PHP API Reference (Unofficial)][5] + +License +------- + +[King'ori J. Maina][10] © 2013. The [MIT License bundled therein][11] is a +permissive license that is short and to the point. It lets people do anything +they want as long as they provide attribution and waive liability. + [1]: http://oauth.net/core/1.0/ [2]: https://github.com/radar/guides/blob/master/gem-development.md [3]: http://guides.rubygems.org/make-your-own-gem/ [4]: http://developer.pesapal.com/how-to-integrate/api-reference [5]: https://github.com/itsmrwave/pesapal-php#pesapal-php-api-reference-unofficial [6]: https://github.com/itsmrwave/pesapal-rubygem/issues [7]: http://rubygems.org/gems/pesapal [8]: https://github.com/itsmrwave/pesapal-rubygem/fork [9]: https://github.com/itsmrwave/pesapal-rubygem#contributing +[10]: http://kingori.co/ +[11]: https://github.com/itsmrwave/pesapal-rubygem/blob/master/LICENSE.txt +[12]: https://github.com/itsmrwave/pesapal-rubygem/releases/ +[13]: http://rubydoc.info/gems/pesapal/