README.md in notifications-ruby-client-1.0.0 vs README.md in notifications-ruby-client-1.1.1

- old
+ new

@@ -1,10 +1,10 @@ # GOV.UK Notify Ruby client API client for GOV.UK Notify written in Ruby. -[![Build Status](https://travis-ci.org/alphagov/notifications-ruby-client.svg?branch=master)](https://travis-ci.org/alphagov/notifications-ruby-client) +[![Gem Version](https://badge.fury.io/rb/notifications-ruby-client.svg)](https://badge.fury.io/rb/notifications-ruby-client) ## Installation Prior to usage an account must be created through the Notify admin console. This will allow access to the API credentials you application. @@ -15,25 +15,16 @@ ``` ## Getting started ```ruby -require 'notifications-ruby-client' -client = Notifications::Client.new(service_id, secret_id) +require 'notifications/client' +client = Notifications::Client.new(api_key) ``` -you can also override api endpoint +Generate an API key by logging in to GOV.UK Notify [GOV.UK Notify](https://www.notifications.service.gov.uk) and going to the **API integration** page. -```ruby -client = Notifications::Client.new(service_id, secret_id, base_url) -client.base_url # => Notifications::Client::PRODUCTION_BASE_URL -``` - -Generate an API key by logging in to GOV.UK Notify [GOV.UK Notify](https://www.notifications.service.gov.uk) and going to the API integration page. - -You will find your service ID on the API integration page. - ### Send a message Text message: ```ruby @@ -154,6 +145,6 @@ <td> Can’t send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode </td> </tr> </tbody> -</table> \ No newline at end of file +</table>