Skip to content

Commit aa630f0

Browse files
authored
Merge pull request #1631 from commercetools/ts_sdk_docs_update
docs(typescript): update the docs for the typescript SDK
2 parents 89f8554 + 8c08238 commit aa630f0

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- [core](/sdk/api/README.md#core)
1212
- [sdk-auth](/sdk/api/sdkAuth.md)
1313
- [sdk-client](/sdk/api/sdkClient.md)
14-
- [typescript-sdk](/sdk/api/typescriptSdk.md)
14+
- [typescript](/sdk/api/typescriptSdk.md)
1515
- [middlewares](/sdk/api/README.md#middlewares)
1616
- [sdk-middleware-auth](/sdk/api/sdkMiddlewareAuth.md)
1717
- [sdk-middleware-http](/sdk/api/sdkMiddlewareHttp.md)

docs/sdk/api/typescriptSdk.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
1-
# `typescript-sdk`(Alpha package)
1+
# `typescript`
22

3-
A package used to provide typescript definitions on top of ctp client
3+
We provide a packages written in typescript for using our API
44

55
![example usage](typescript_tutorial.gif)
66

7+
The source code for these packages are located in the [typescript](https://github.com/commercetools/commercetools-sdk-typescript/) repository.
8+
79
## Install
810

911
#### Node.js
1012

1113
```bash
12-
npm install --save @commercetools/typescript-sdk
14+
npm install --save @commercetools/platform-sdk
15+
npm install --save @commercetools/importapi-sdk
16+
npm install --save @commercetools/ml-sdk
1317
```
1418

1519
#### Browser
1620

1721
```html
18-
<script src="https://unpkg.com/@commercetools/typescript-sdk/lib/typescript-sdk.umd.min.js"></script>
22+
<script src="https://unpkg.com/@commercetools/platform-sdk/dist/platform-sdk.umd.js"></script>
1923
<script>
2024
// global: TypescriptSdk
2125
</script>
@@ -30,7 +34,7 @@ import { createClient } from '@commercetools/sdk-client'
3034
import {
3135
createApiBuilderFromCtpClient,
3236
ApiRoot,
33-
} from '@commercetools/typescript-sdk'
37+
} from '@commercetools/platform-sdk'
3438
import fetch from 'node-fetch'
3539

3640
const projectKey = 'some_project_key'

0 commit comments

Comments
 (0)