adjust readme

shojisoma · Aug 26, 2022 · e39de2f · e39de2f
1 parent 43a70c3
commit e39de2f
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/samples/cf-sample-application/README.md b/samples/cf-sample-application/README.md
@@ -53,7 +53,7 @@ Please download the following service definitions  in `EDMX` format from the API
 - [Business Partner service cloud](https://api.sap.com/api/API_BUSINESS_PARTNER/overview)
 
 Store the two files as `cloud-business-partner-service.edmx` and `op-business-partner-service.edmx` in the folder `resources/service-specs`.
-Generate the client by executing the npm command `npm run generate-client`
+Run `npm i` and generate the client by executing the npm command `npm run generate-client`
 
 ### Create Services on SAP BTP Cloud Foundry
 Before you can deploy the application and approuter, you have to create a `destination`, `xsuaa`, and `connectivity` service instance.

diff --git a/samples/helm-sample-application/application/README.md b/samples/helm-sample-application/application/README.md
@@ -51,6 +51,16 @@ cd cloud-sdk-js
 git sparse-checkout set samples/helm-sample-application
 ```
 
+### Create oData Client
+
+Due to intellectual property reasons we are not allowed to include SAP service definitions in this open source repository.
+Please download the following service definitions  in `EDMX` format from the API hub:
+- [Business Partner service onPremise](https://api.sap.com/api/OP_API_BUSINESS_PARTNER_SRV/overview)
+- [Business Partner service cloud](https://api.sap.com/api/API_BUSINESS_PARTNER/overview)
+
+Store the two files as `cloud-business-partner-service.edmx` and `op-business-partner-service.edmx` in the folder `resources/service-specs`.
+Run `npm i` and generate the client by executing the npm command `npm run generate-client`
+
 ### Deploy to Docker
 1. In the `package.json`, change the `deploy:docker` and `deploy:pipeline` scripts to point at your docker repository.
 2. Change the the `deploy:docker` script in the approuter's `package.json` to point at your docker repository.

diff --git a/samples/k8s-sample-application/README.md b/samples/k8s-sample-application/README.md
@@ -50,6 +50,16 @@ cd cloud-sdk-js
 git sparse-checkout set samples/k8s-sample-application
 ```
 
+### Create oData Client
+
+Due to intellectual property reasons we are not allowed to include SAP service definitions in this open source repository.
+Please download the following service definitions  in `EDMX` format from the API hub:
+- [Business Partner service onPremise](https://api.sap.com/api/OP_API_BUSINESS_PARTNER_SRV/overview)
+- [Business Partner service cloud](https://api.sap.com/api/API_BUSINESS_PARTNER/overview)
+
+Store the two files as `cloud-business-partner-service.edmx` and `op-business-partner-service.edmx` in the folder `resources/service-specs`.
+Run `npm i` and generate the client by executing the npm command `npm run generate-client`
+
 ### Deploy to Docker
 1. In the `package.json`, change the `deploy:docker` and `deploy:pipeline` scripts to point at your docker repository.
 2. Change the the `deploy:docker` script in the approuter's `package.json` to point at your docker repository.
@@ -65,4 +75,4 @@ git sparse-checkout set samples/k8s-sample-application
 ### Code Placeholders
 If anything isn't working as intended, search for `<REPLACE-ME>`, as all parts that have to be adapted contain this placeholder.
 
-For more detailed information on Kubernetes deployment, check out our [Kubernetes migration guide](https://sap.github.io/cloud-sdk/docs/js/guides/migrate-sdk-application-from-btp-cf-to-kubernetes).
+For more detailed information on Kubernetes deployment, check out our [Kubernetes migration guide](https://sap.github.io/cloud-sdk/docs/js/guides/migrate-sdk-application-from-btp-cf-to-kubernetes).