README.md in hyperclient-0.8.6 vs README.md in hyperclient-0.9.0

- old
+ new

@@ -6,27 +6,25 @@ [![Code Climate](https://codeclimate.com/github/codegram/hyperclient.svg)](https://codeclimate.com/github/codegram/hyperclient) [![Coverage Status](https://img.shields.io/coveralls/codegram/hyperclient.svg)](https://coveralls.io/r/codegram/hyperclient?branch=master) Hyperclient is a Hypermedia API client written in Ruby. It fully supports [JSON HAL](http://stateless.co/hal_specification.html). -* [Hyperclient](#hyperclient) -* [Usage](#usage) - * [API Client](#api-client) - * [Resources and Attributes](#resources-and-attributes) - * [Links and Embedded Resources](#links-and-embedded-resources) - * [Templated Links](#templated-links) - * [Curies](#curies) - * [Attributes](#attributes) - * [HTTP](#http) - * [Asynchronous requests](#asynchronous-requests) -* [Testing Using Hyperclient](#testing-using-hyperclient) -* [Reference](#reference) -* [Hyperclient Users](#hyperclient-users) -* [Contributing](#contributing) -* [License](#license) +# Table of Contents -<sub><sup>ToC created with [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)</sup></sub> +- [Usage](#usage) + - [API Client](#api-client) + - [Resources and Attributes](#resources-and-attributes) + - [Links and Embedded Resources](#links-and-embedded-resources) + - [Templated Links](#templated-links) + - [Curies](#curies) + - [Attributes](#attributes) + - [HTTP](#http) +- [Testing Using Hyperclient](#testing-using-hyperclient) +- [Reference](#reference) +- [Hyperclient Users](#hyperclient-users) +- [Contributing](#contributing) +- [License](#license) # Usage The examples in this README use the [Splines Demo API](https://github.com/ruby-grape/grape-with-roar) running [here](https://grape-with-roar.herokuapp.com/api). If you're upgrading from a previous version, please make sure to read [UPGRADING](UPGRADING.md). @@ -203,27 +201,10 @@ spline._delete ``` HTTP methods always return a new instance of Resource. -## Asynchronous requests - -By default, Hyperclient requests are performed asynchronously in a background thread pool via the [Futuroscope](https://github.com/codegram/futuroscope) gem. You can control the size of this pool by setting the `min_workers` and `max_workers` settings: - -```ruby -Futuroscope.default_pool.min_workers = 10 -Futuroscope.default_pool.max_workers = 20 -``` - -If you want to disable this behavior and have all requests performed synchronously, you can use the client `options` to disable this behavior: - -```ruby -api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client| - client.options[:async] = false -end -``` - # Testing Using Hyperclient You can combine RSpec, Faraday::Adapter::Rack and Hyperclient to test your HAL API without having to ever examine the raw JSON response. ```ruby @@ -263,6 +244,8 @@ Hyperclient is work of [many people](https://github.com/codegram/hyperclient/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/codegram/hyperclient/pulls), [propose features and discuss issues](https://github.com/codegram/hyperclient/issues). See [CONTRIBUTING](CONTRIBUTING.md) for details. # License -MIT License, see [LICENSE](LICENSE) for details. Copyright 2012-2014 [Codegram Technologies](http://codegram.com). +MIT License, see [LICENSE](LICENSE) for details. + +Copyright (c) 2012-2018 Oriol Gual, [Codegram Technologies](http://codegram.com) and Contributors