Skip to content

Commit 926f4ed

Browse files
Publishes pre-release 1
1 parent e902b7e commit 926f4ed

File tree

7 files changed

+31
-17
lines changed

7 files changed

+31
-17
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
This repository contains the source code for the Content Delivery SDKs and samples.
77

8+
> Note the SDK is in preview. Please provide feedback and report issues.
9+
810
Visit [Episerver World](https://world.episerver.com/documentation/developer-guides/content-delivery-api/) for full documentation of the REST APIs.
911

1012
## Content Definitions

src/@episerver/content-definitions/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Please visit [Episerver World](https://world.episerver.com/) for full documentat
99
Using npm:
1010

1111
```bash
12-
$ npm install @episerver/content-definitions
12+
$ npm install @episerver/content-definitions@latest --save-dev
1313
````
1414

1515
using yarn:
1616

1717
```bash
18-
$ yarn install @episerver/content-definitions
18+
$ yarn install @episerver/content-definitions@latest --save-dev
1919
````
2020
2121
## Examples

src/@episerver/content-definitions/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/@episerver/content-definitions/package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
{
22
"name": "@episerver/content-definitions",
3-
"version": "1.0.0",
4-
"description": "Episerver tool for managing content definitions manifest files.",
5-
"author": "Johan Petersson <johan.petersson@episerver.com>",
3+
"version": "1.0.0-pre.1",
4+
"description": "CLI tool for managing content definitions manifest files.",
5+
"author": "Johan Petersson <johan.petersson@optimizely.com>",
66
"license": "Apache-2.0",
77
"keywords": [
88
"episerver",
9+
"optimizely",
910
"manifest",
1011
"definitions"
1112
],

src/@episerver/content-delivery/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,29 @@
22

33
SDK for loading and resolving content from an Episerver application running the [Content Delivery API](https://world.episerver.com/documentation/developer-guides/content-delivery-api/). The SDK is written in TypeScript and includes types.
44

5-
Please visit [Episerver World](https://world.episerver.com/) for full documentation of the APIs.
5+
Please visit [Episerver World](https://world.episerver.com/) for full documentation of the APIs.
6+
7+
> Note that this SDK requires you to use the flattened JSON format, see code example below how to configure the API to use this format.
8+
9+
```cs
10+
services.AddContentDeliveryApi(options =>
11+
{
12+
options.FlattenPropertyModel = true;
13+
});
14+
```
615

716
## Installing
817

918
Using npm:
1019

1120
```bash
12-
$ npm install @episerver/content-delivery
21+
$ npm install @episerver/content-delivery@latest
1322
````
1423

1524
using yarn:
1625

1726
```bash
18-
$ yarn install @episerver/content-delivery
27+
$ yarn install @episerver/content-delivery@latest
1928
````
2029
2130
## Examples

src/@episerver/content-delivery/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/@episerver/content-delivery/package.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
{
22
"name": "@episerver/content-delivery",
3-
"version": "1.0.0",
4-
"description": "Episerver SDK for content delivery.",
5-
"author": "Johan Petersson <johan.petersson@episerver.com>",
3+
"version": "1.0.0-pre.1",
4+
"description": "SDK for the Episerver Content Delivery API.",
5+
"author": "Johan Petersson <johan.petersson@optimizely.com>",
66
"license": "Apache-2.0",
77
"keywords": [
88
"episerver",
9+
"optimizely",
910
"content delivery",
1011
"headless",
11-
"sdk"
12+
"sdk",
13+
"client"
1214
],
1315
"homepage": "https://www.episerver.com",
1416
"repository": {
@@ -21,7 +23,7 @@
2123
"scripts": {
2224
"build": "npx tsc",
2325
"watch": "npx tsc --watch",
24-
"test": "mocha --recursive --timeout 5000 --require ./test/fixture.mjs"
26+
"test": "mocha --recursive --timeout 5000 --require ./test/fixture.mjs"
2527
},
2628
"devDependencies": {
2729
"@types/chai": "^4.2.17",

0 commit comments

Comments
 (0)