Skip to content

Commit e22a8aa

Browse files
committed
READMEの修正
1 parent 616f23a commit e22a8aa

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It helps you to use microCMS from JavaScript and Node.js applications.
88

99
See the [official tutorial](https://document.microcms.io/tutorial/javascript/javascript-top).
1010

11-
## Getting Started
11+
## Getting started
1212

1313
### Installation
1414

@@ -87,23 +87,22 @@ const client = createClient({
8787

8888
### API Methods
8989

90-
The table below shows each API method of microCMS and indicates which API format (List Format or Object Format) they can be used with using ✔️.
90+
The table below shows each API method of microCMS JavaScript SDK and indicates which API format (List Format or Object Format) they can be used with using ✔️.
9191

92-
| Method | List Format | Object Format | Both |
93-
|-------------------|-------------|---------------|------|
94-
| getList | ✔️ | | |
95-
| getListDetail | ✔️ | | |
96-
| getObject | | ✔️ | |
97-
| getAllContentIds | ✔️ | | |
98-
| getAllContents | ✔️ | | |
99-
| create | ✔️ | | |
100-
| update | | | ✔️ |
101-
| delete | ✔️ | | |
92+
| Method | List Format | Object Format |
93+
|-------------------|-------------|---------------|
94+
| getList | ✔️ | |
95+
| getListDetail | ✔️ | |
96+
| getObject | | ✔️ |
97+
| getAllContentIds | ✔️ | |
98+
| getAllContents | ✔️ | |
99+
| create | ✔️ | |
100+
| update | ✔️ | ✔️ |
101+
| delete | ✔️ | |
102102

103103
> [!NOTE]
104104
> - ✔️ in "List Format" indicates the method can be used when the API type is set to List Format.
105105
> - ✔️ in "Object Format" indicates the method can be used when the API type is set to Object Format.
106-
> - ✔️ in "Both" indicates the method can be used with both List and Object Formats.
107106
108107
### Get content list
109108

@@ -397,7 +396,7 @@ client
397396

398397
If you are using TypeScript, use `getList`, `getListDetail`, `getObject`. This internally contains a common type of content.
399398

400-
#### Response Type for getList Method
399+
#### Response type for getList method
401400

402401
```typescript
403402
type Content = {
@@ -414,7 +413,7 @@ type Content = {
414413
client.getList<Content>({ /* other */ })
415414
```
416415

417-
#### Response Type for getListDetail Method
416+
#### Response type for getListDetail method
418417

419418
```typescript
420419
type Content = {
@@ -433,7 +432,7 @@ type Content = {
433432
client.getListDetail<Content>({ /* other */ })
434433
```
435434

436-
#### Response Type for getObject Method
435+
#### Response type for getObject method
437436

438437
```typescript
439438
type Content = {
@@ -452,7 +451,7 @@ type Content = {
452451
client.getObject<Content>({ /* other */ })
453452
```
454453

455-
#### Response Type for getAllContentIds Method
454+
#### Response type for getAllContentIds method
456455

457456
```typescript
458457
/**
@@ -461,7 +460,7 @@ client.getObject<Content>({ /* other */ })
461460
client.getAllContentIds({ /* other */ })
462461
```
463462

464-
#### create Method with Type Safety
463+
#### Create method with type safety
465464

466465
Since `content` will be of type `Content`, no required fields will be missed.
467466

@@ -480,7 +479,7 @@ client.create<Content>({
480479
});
481480
```
482481

483-
#### update Method with Type Safety
482+
#### Update method with type safety
484483

485484
The `content` will be of type `Partial<Content>`, so you can enter only the items needed for the update.
486485

@@ -569,7 +568,7 @@ const client = createManagementClient({
569568
});
570569
```
571570

572-
### Upload Media
571+
### Upload media
573572

574573
Media files can be uploaded using the 'POST /api/v1/media' endpoint of the Management API.
575574

@@ -636,7 +635,7 @@ client
636635

637636
### TypeScript
638637

639-
#### Parameter Type for uploadMedia Method
638+
#### Parameter type for uploadMedia method
640639

641640
```typescript
642641
type UploadMediaRequest =

0 commit comments

Comments
 (0)