Skip to content

Commit 15a5024

Browse files
committed
read me doc review update
1 parent 48b356d commit 15a5024

2 files changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Contentstack Management JavaScript SDK
44

5-
Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
5+
Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. All you have to do is build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
66

7-
This SDK use Content Management API(CMA). The Content Management API (CMA) is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account. To use the Content Management API, you will need to authenticate yourself with a [Management Token](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens) or an [Authtoken](https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken). Read more about it in [Authentication](https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication).
7+
This SDK uses the [Content Management API](https://www.contentstack.com/docs/developers/apis/content-management-api/) (CMA). The CMA is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account. To use the CMA, you will need to authenticate your users with a [Management Token](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens) or an [Authtoken](https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken). Read more about it in [Authentication](https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication).
88

9-
Note: The Content Management APIs also include many GET requests. However, it is highly recommended that you always use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) to deliver content to your web or mobile properties.
9+
Note: By using CMA, you can execute GET requests for fetching content. However, we strongly recommend that you always use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) to deliver content to your web or mobile properties.
1010

1111
### Prerequisite
1212

13-
You need Node.js version 10 or later installed to use the Contentstack JavaScript CMA SDK.
13+
You need Node.js version 10 or above installed on your machine to use the Contentstack JavaScript CMA SDK.
1414

1515
### Installation
1616
#### Node
@@ -20,7 +20,7 @@ npm i contentstack-management
2020
```
2121
To import the SDK, use the following command:
2222
```
23-
import contentstack from ‘@contentstack/contentstack-mangement
23+
import contentstack from ‘@contentstack/contentstack-management
2424
```
2525
To initialize the SDK, you will need to pass ```axios``` instance as follows:
2626
```
@@ -29,15 +29,15 @@ contentstackClient = contentstack.client(axios, {})
2929
```
3030

3131
### Authentication
32-
To use this SDK, you need to authenticate users. You can do this by using the Authtoken, credentials, or Management Token (stack-level token). Let's discuss them in detail.
32+
To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).
3333
### Authtoken
3434
An [Authtoken](https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens/#authentication-tokens-authtokens-) is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
3535
```
3636
import axios from 'axios'
3737
contentstackClient = contentstack.client(axios, { authtoken: 'AUTHTOKEN' })
3838
```
3939
### Login
40-
To log in to Contentstack, provide your credentials in the following code:
40+
To Login to Contentstack by using credentials, you can use the following lines of code:
4141
```
4242
contentstackClient.login({ email: 'EMAIL', password: 'PASSWORD'})
4343
.then((response) => {
@@ -56,16 +56,16 @@ contentstackClient.stack('API_KEY', 'MANAGEMENT_TOKEN')
5656
})
5757
```
5858
### Contentstack Management JavaScript SDK: 5-minute Quickstart
59-
#### Initializing your SDK:
59+
#### Initializing Your SDK:
6060
To use the JavaScript CMA SDK, you need to first initialize it. To do this, use the following code:
6161
```
62-
import contentstack from ‘@contentstack/contentstack-mangement
62+
import contentstack from ‘@contentstack/contentstack-management
6363
import axios from 'axios'
6464
6565
var contentstackClient = contentstack.client(axios, { authtoken: 'AUTHTOKEN' })
6666
```
67-
#### Fetch Stack details
68-
To fetch your stack details through the SDK, use the following lines of code:
67+
#### Fetch Stack Detail
68+
Use the following lines of code to fetch your stack detail using this SDK:
6969
```
7070
contentstackClient.stack('API_KEY')
7171
.fetch()
@@ -75,7 +75,7 @@ contentstackClient.stack('API_KEY')
7575
```
7676

7777
#### Create Entry
78-
You can use the following lines of code to create an entry in a specific content type of a stack through the SDK:
78+
To create an entry in a specific content type of a stack, use the following lines of code:
7979
```
8080
var entry = {
8181
title: 'Sample Entry',
@@ -89,7 +89,7 @@ contentstackClient.stack('API_KEY').contentType('CONTENT_TYPE_UID').entry().crea
8989
```
9090

9191
#### Create Asset
92-
Use the following code snippet to upload assets to your stack through the SDK:
92+
The following lines of code can be used to upload assets to your stack:
9393
```
9494
var asset = {
9595
upload: 'path/to/file',

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"generate:docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
3535
},
3636
"engines": {
37-
"node": ">=8.0.0 <11.0.0"
37+
"node": ">=8.0.0"
3838
},
3939
"author": "Contentstack",
4040
"license": "MIT",

0 commit comments

Comments
 (0)