Minor documentation updates

ably · Apr 15, 2015 · b3c1565 · b3c1565
1 parent 69f60b0
commit b3c1565
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
-# [Ably](https://ably.io)
+# [Ably](https://www.ably.io)
 
 [![Build Status](https://travis-ci.org/ably/ably-ruby.png)](https://travis-ci.org/ably/ably-ruby)
 [![Gem Version](https://badge.fury.io/rb/ably.svg)](http://badge.fury.io/rb/ably)
 [![Coverage Status](https://coveralls.io/repos/ably/ably-ruby/badge.svg)](https://coveralls.io/r/ably/ably-ruby)
 
-A Ruby client library for [ably.io](https://ably.io), the realtime messaging service.
+A Ruby client library for [ably.io](https://www.ably.io), the realtime messaging service.
 
 ## Documentation
 
-Visit https://ably.io/documentation for a complete API reference and more examples.
+Visit https://www.ably.io/documentation for a complete API reference and more examples.
 
 ## Installation
 

diff --git a/lib/ably/auth.rb b/lib/ably/auth.rb
@@ -5,9 +5,9 @@
 require 'ably/rest/middleware/external_exceptions'
 
 module Ably
-  # Auth is responsible for authentication with {https://ably.io Ably} using basic or token authentication
+  # Auth is responsible for authentication with {https://www.ably.io Ably} using basic or token authentication
   #
-  # Find out more about Ably authentication at: http://docs.ably.io/other/authentication/
+  # Find out more about Ably authentication at: https://www.ably.io/documentation/general/authentication/
   #
   # @!attribute [r] client_id
   #   @return [String] The provided client ID, used for identifying this client for presence purposes
@@ -175,9 +175,9 @@ def request_token(options = {})
     # @param [Hash] options the options for the token request
     # @option options [String]  :key        complete API key for the designated application
     # @option options [String]  :client_id  client ID identifying this connection to other clients
-    # @option options [Integer] :ttl        validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {http://docs.ably.io/other/authentication/}
+    # @option options [Integer] :ttl        validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.io/documentation/other/authentication}
     # @option options [Hash]    :capability canonicalised representation of the resource paths and associated operations
-    # @option options [Boolean] :query_time when true will query the {https://ably.io Ably} system for the current time instead of using the local time
+    # @option options [Boolean] :query_time when true will query the {https://www.ably.io Ably} system for the current time instead of using the local time
     # @option options [Time]    :timestamp  the time of the of the request
     # @option options [String]  :nonce      an unquoted, unescaped random string of at least 16 characters
     #

diff --git a/lib/ably/modules/http_helpers.rb b/lib/ably/modules/http_helpers.rb
@@ -18,7 +18,7 @@ def encode64(text)
     end
 
     def user_agent
-      "Ably Ruby client #{Ably::VERSION} (https://ably.io)"
+      "Ably Ruby client #{Ably::VERSION} (https://www.ably.io)"
     end
 
     def setup_outgoing_middleware(builder)

diff --git a/lib/ably/rest/client.rb b/lib/ably/rest/client.rb
@@ -73,7 +73,7 @@ class Client
       # @option options [String]                  :key                 API key comprising the key name and key secret in a single string
       # @option options [String]                  :token               Token string or {Models::TokenDetails} used to authenticate requests
       # @option options [String]                  :token_details       {Models::TokenDetails} used to authenticate requests
-      # @option options [Boolean]                 :use_token_auth      Will force Basic Auth if set to false, and TOken auth if set to true
+      # @option options [Boolean]                 :use_token_auth      Will force Basic Auth if set to false, and Token auth if set to true
       # @option options [String]                  :environment         Specify 'sandbox' when testing the client library against an alternate Ably environment
       # @option options [Symbol]                  :protocol            Protocol used to communicate with Ably, :json and :msgpack currently supported. Defaults to :msgpack
       # @option options [Boolean]                 :use_binary_protocol Protocol used to communicate with Ably, defaults to true and uses MessagePack protocol.  This option will overide :protocol option