-
Notifications
You must be signed in to change notification settings - Fork 202
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): add missing configs and small adjustments
- Loading branch information
Showing
1 changed file
with
19 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,8 +11,8 @@ | |
| [](https://github.com/semantic-release/semantic-release) | ||
| [](http://standardjs.com/) | ||
| [](http://npm-stat.com/charts.html?package=contentful) | ||
| [](https://unpkg.com/contentful/dist/contentful.min.js) | ||
| [](https://unpkg.com/contentful/dist/contentful.browser.min.js) | ||
|
|
||
| [Contentful](https://www.contentful.com) is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via a powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations. | ||
|
|
||
|
|
@@ -67,14 +67,14 @@ yarn add contentful | |
| If you'd like to use a standalone built file you can use the following script tag or download it from [unpkg](https://unpkg.com), under the `dist` directory: | ||
|
|
||
| ``` html | ||
| <script src="https://unpkg.com/contentful@latest/dist/contentful.min.js"></script> | ||
| <script src="https://unpkg.com/contentful@latest/dist/contentful.browser.min.js"></script> | ||
| ``` | ||
| **It's not recommended to use the above URL for production.** | ||
|
|
||
| Using `contentful@latest` will always get you the latest version, but you can also specify a specific version number: | ||
|
|
||
| ``` html | ||
| <script src="https://unpkg.com/[email protected]/dist/contentful.min.js"></script> | ||
| <script src="https://unpkg.com/[email protected]/dist/contentful.browser.min.js"></script> | ||
| ``` | ||
|
|
||
| The Contentful Delivery SDK will be accessible via the `contentful` global variable. | ||
|
|
@@ -85,7 +85,7 @@ Check the [releases](https://github.com/contentful/contentful.js/releases) page | |
|
|
||
| This library also comes with a legacy version to support Internet Explorer 11 and other older browsers. It already contains a polyfill for Promises. | ||
|
|
||
| To support legacy browsers in your application, use `contentful.legacy.min.js` instead of `contentful.min.js` | ||
| To support legacy browsers in your application, use `contentful.legacy.min.js` instead of `contentful.browser.min.js` | ||
|
|
||
| ## Authentication | ||
|
|
||
|
|
@@ -278,19 +278,27 @@ This path gets appended to the host to allow request urls like `https://gateway. | |
| #### httpAgent (default: `undefined`) | ||
| Custom agent to perform HTTP requests. Find further information in the [axios request config documentation](https://github.com/mzabriskie/axios#request-config). | ||
|
|
||
| #### httpsAgent (default: `undefined`) | ||
| Custom agent to perform HTTPS requests. Find further information in the [axios request config documentation](https://github.com/mzabriskie/axios#request-config). | ||
|
|
||
| #### headers (default: `[]`) | ||
| Additional headers to attach to the requests. We add/overwrite the following headers: | ||
|
|
||
| * Content-Type: `application/vnd.contentful.management.v1+json` | ||
| * X-Contentful-User-Agent: `sdk contentful.js/1.2.3; platform node.js/1.2.3; os macOS/1.2.3` | ||
| (Automatically generated) | ||
|
|
||
| #### proxy (default: `undefined`) | ||
| Axios proxy configuration. See the [axios request config documentation](https://github.com/mzabriskie/axios#request-config) for further information about the supported values. | ||
|
|
||
| #### resolveLinks (default: `true`) | ||
| Turn off to disable link resolving. | ||
|
|
||
| #### retryOnError (default: `true`) | ||
| By default, this SDK is retrying requests which resulted in a 500 server error and 429 rate limit response. Set this to `false` to disable this behavior. | ||
|
|
||
| #### logHandler (default: `function (level, data) {}`) | ||
| Errors and warnings will be logged by default to the node or browser console. Pass your own log handler to intercept here and handle errors, warnings and info on your own. | ||
|
|
||
| ### Reference documentation | ||
|
|
||
|
|
@@ -322,6 +330,12 @@ This means that new versions are released automatically as fixes, features or br | |
|
|
||
| You can check the changelog on the [releases](https://github.com/contentful/contentful.js/releases) page. | ||
|
|
||
| ## Migration from contentful.js 4.x | ||
|
|
||
| The bundle for browsers is now called `contentful.browser.min.js` to mark it clearly as browser only bundle. If you need to support IE 11 or other old browsers, you may use the `contentful.legacy.min.js`. Node will automatically use the `contentful.node.min.js` while bundlers like Webpack will resolve to the new ES-modules version of the library. | ||
|
|
||
| No changes to the API of the library were made. | ||
|
|
||
| ## Migration from contentful.js 3.x | ||
|
|
||
| From version 4.0.0 and up contentful.js is exported as a single `umd` bundle the cdn distribution has changed, there is no more `browser-dist`. the new link format is https://unpkg.com/contentful@version/dist/contentful.min.js instead of https://unpkg.com/contentful@version/browser-dist/contentful.min.js. to access version 3 you can still use https://unpkg.com/[email protected]/browser-dist/contentful.min.js | ||
|
|
||