README.md in contentful_middleman-1.5.0 vs README.md in contentful_middleman-2.0.0
- old
+ new
@@ -52,10 +52,11 @@
Parameter | Description
---------- | ------------
space | Hash with an user choosen name for the space as key and the space id as value
access_token | Contentful Delivery API access token
cda_query | Hash describing query configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info (look for filter options there). Note that by default only 100 entries will be fetched, this can be configured to up to 1000 entries using the `limit` option. Example: `f.cda_query = { limit: 1000 }`
+cda_query | Hash describing client configuration. See [contentful.rb](https://github.com/contentful/contentful.rb#client-configuration-options) for more info. This option should commonly be used to change Rate Limit Management, Include Resolution, Logging and Proxies.
content_types | Hash describing the mapping applied to entries of the imported content types
default_locale | String with the value for the default locale for your space. Defaults to `'en-US'`.
use_preview_api | Boolean to toggle the used API. Set it to `false` to use `cdn.contentful.com` (default value). Set it to `true` to use `preview.contentful.com`. More info in [the documentation](https://www.contentful.com/developers/documentation/content-delivery-api/#preview-api)
all_entries | Boolean to toggle multiple requests to the API for getting over 1000 entries. This uses a naive approach and can get rate limited. When using this, have in mind adding an `order` in your `:cda_query` . Default order is `order: 'sys.createdAt'`
all_entries_page_size | Integer amount of items per page for `:all_entries` requests, allowing for smaller page sizes on content heavy requests.
@@ -328,5 +329,9 @@
) do |preview| %>
<!-- do your stuff -->
<% end %>
```
+## Platform Specific Deployment Caveats
+
+For platform specific issues, please look into the [DEPLOYING](./DEPLOYING.md) document. This document is expected to grow with user contributions.
+Feel free to add your own discoveries to that file by issuing a Pull Request.