Publishes pre-release 1

episerver · Jul 5, 2021 · 926f4ed · 926f4ed
1 parent e902b7e
commit 926f4ed
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@
 
 This repository contains the source code for the Content Delivery SDKs and samples.
 
+> Note the SDK is in preview. Please provide feedback and report issues.
+
 Visit [Episerver World](https://world.episerver.com/documentation/developer-guides/content-delivery-api/) for full documentation of the REST APIs.
 
 ## Content Definitions

diff --git a/src/@episerver/content-definitions/README.md b/src/@episerver/content-definitions/README.md
@@ -9,13 +9,13 @@ Please visit [Episerver World](https://world.episerver.com/) for full documentat
 Using npm:
 
 ```bash
-$ npm install @episerver/content-definitions
+$ npm install @episerver/content-definitions@latest --save-dev
 ````
 
 using yarn:
 
 ```bash
-$ yarn install @episerver/content-definitions
+$ yarn install @episerver/content-definitions@latest --save-dev
 ````
 
 ## Examples

diff --git a/src/@episerver/content-definitions/package-lock.json b/src/@episerver/content-definitions/package-lock.json
diff --git a/src/@episerver/content-definitions/package.json b/src/@episerver/content-definitions/package.json
@@ -1,11 +1,12 @@
 {
   "name": "@episerver/content-definitions",
-  "version": "1.0.0",
-  "description": "Episerver tool for managing content definitions manifest files.",
-  "author": "Johan Petersson <johan.petersson@episerver.com>",
+  "version": "1.0.0-pre.1",
+  "description": "CLI tool for managing content definitions manifest files.",
+  "author": "Johan Petersson <johan.petersson@optimizely.com>",
   "license": "Apache-2.0",
   "keywords": [
     "episerver",
+    "optimizely",
     "manifest",
     "definitions"
   ],

diff --git a/src/@episerver/content-delivery/README.md b/src/@episerver/content-delivery/README.md
@@ -2,20 +2,29 @@
 
 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.
 
-Please visit [Episerver World](https://world.episerver.com/) for full documentation of the APIs. 
+Please visit [Episerver World](https://world.episerver.com/) for full documentation of the APIs.
+
+> 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.
+
+```cs
+services.AddContentDeliveryApi(options => 
+{
+    options.FlattenPropertyModel = true;
+});
+```
 
 ## Installing
 
 Using npm:
 
 ```bash
-$ npm install @episerver/content-delivery
+$ npm install @episerver/content-delivery@latest
 ````
 
 using yarn:
 
 ```bash
-$ yarn install @episerver/content-delivery
+$ yarn install @episerver/content-delivery@latest
 ````
 
 ## Examples

diff --git a/src/@episerver/content-delivery/package-lock.json b/src/@episerver/content-delivery/package-lock.json
diff --git a/src/@episerver/content-delivery/package.json b/src/@episerver/content-delivery/package.json
@@ -1,14 +1,16 @@
 {
   "name": "@episerver/content-delivery",
-  "version": "1.0.0",
-  "description": "Episerver SDK for content delivery.",
-  "author": "Johan Petersson <johan.petersson@episerver.com>",
+  "version": "1.0.0-pre.1",
+  "description": "SDK for the Episerver Content Delivery API.",
+  "author": "Johan Petersson <johan.petersson@optimizely.com>",
   "license": "Apache-2.0",
   "keywords": [
     "episerver",
+    "optimizely",
     "content delivery",
     "headless",
-    "sdk"
+    "sdk",
+    "client"
   ],
   "homepage": "https://www.episerver.com",
   "repository": {
@@ -21,7 +23,7 @@
   "scripts": {
     "build": "npx tsc",
     "watch": "npx tsc --watch",
-    "test": "mocha --recursive --timeout 5000 --require ./test/fixture.mjs" 
+    "test": "mocha --recursive --timeout 5000 --require ./test/fixture.mjs"
   },
   "devDependencies": {
     "@types/chai": "^4.2.17",