README.md in datadog_api_client-1.6.0 vs README.md in datadog_api_client-1.7.0

- old
+ new

@@ -16,58 +16,58 @@ ### Install published Ruby gem 1. Add the `datadog_api_client` gem to you Gemfile: - ```ruby - source 'https://rubygems.org' - gem 'datadog_api_client' - ``` + ```ruby + source 'https://rubygems.org' + gem 'datadog_api_client' + ``` 2. Install the gem with `bundle install` 3. (optional) You can configure site and [authentication](#authentication) using environment variables or code block: - ```ruby - DatadogAPIClient::V1.configure do |config| - config.server_variables[:site] = 'datadoghq.eu' - end - ``` + ```ruby + DatadogAPIClient::V1.configure do |config| + config.server_variables[:site] = 'datadoghq.eu' + end + ``` ### Build a gem 1. Build the Ruby code into a gem: - ```shell - gem build datadog_api_client.gemspec - ``` + ```shell + gem build datadog_api_client.gemspec + ``` 2. Install the gem locally: - ```shell - gem install ./datadog_api_client-*.gem - ``` + ```shell + gem install ./datadog_api_client-*.gem + ``` ### Install from Git 1. Add the following in the Gemfile: - ```ruby - gem 'datadog_api_client', :git => 'https://github.com/DataDog/datadog-api-client-ruby.git' - ``` + ```ruby + gem 'datadog_api_client', :git => 'https://github.com/DataDog/datadog-api-client-ruby.git' + ``` 2. Install the gem with `bundle install` ### Include the Ruby code directly 1. Create `example.rb` script (find inspiration on https://docs.datadoghq.com/api/) 2. Include the Ruby code directly using `-I` as follows: - ```shell - ruby -Ilib example.rb - ``` + ```shell + ruby -Ilib example.rb + ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following Ruby code: @@ -139,18 +139,18 @@ client = DatadogAPIClient::V1::APIClient.new(config) ``` ## Documentation -If you are interested in general documentation for all public Datadog API endpoints, checkout the [general documentation site](api docs). +If you are interested in general documentation for all public Datadog API endpoints, checkout the [general documentation site][api docs]. -Developer documentation for supported endpoints and models is divided based on API version prefix to [`v1`](/docs/v1/README.md) and [`v2`](/docs/v2/README.md). +Developer documentation for supported endpoints and models is available in [Github pages][github pages]. -For contributing, checkout the [contribution guidelines](contribution docs) and [development guide][development docs]. +For contributing, checkout the [development guide][development docs]. ## Author support@datadoghq.com [api docs]: https://docs.datadoghq.com/api/ -[contribution docs]: https://github.com/DataDog/datadog-api-client-ruby/blob/master/CONTRIBUTING.md +[github pages]: https://datadoghq.dev/datadog-api-client-ruby/ [development docs]: https://github.com/DataDog/datadog-api-client-ruby/blob/master/DEVELOPMENT.md