Skip to content

Commit a692e0f

Browse files
authored
update README
1 parent 78e400c commit a692e0f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,25 @@ sts -c .stsconfig.js
2727
`sts input -g inputGroup -o output ...`
2828

2929
### required
30-
* **input**
30+
* **input**
3131
Strapi folder(s) with models *.settings.json
3232
You may define multiple inputs. In case your API models have relations to other plugins like 'users-permissions'.
3333
`sts path/to/strapi/api/ path/to/strapi/plugins/users-permissions/models -o path/to/your/types/dir/`
3434

35-
* **-g inputGroup**
35+
* **-g inputGroup**
3636
Strapi folder(s) with groups models
3737

3838
### optional
39-
* **-o output**
39+
* **-o output**
4040
Output folder
41-
* **-n nested**
41+
* **-n nested**
4242
Put all interfaces in a nested tree instead of directly under the output folder
43-
* **-u collectionCanBeUndefined**
43+
* **-u collectionCanBeUndefined**
4444
By default, all collection can not be undefined. You can turn this off, so only unrequired collections may be undefined.
45-
* **-e Enumeration**
45+
* **-e Enumeration**
4646
You may generate **enumeration** or **string literal**
4747
Example:
48-
```typescript
48+
```typescript
4949
// enumeration (with -e option)
5050
export interface IOrder {
5151
payment: IOrderPayment;
@@ -58,9 +58,9 @@ export enum IOrderPayment {
5858
export interface IOrder {
5959
payment: "card" | "check";
6060
}
61-
```
61+
```
6262

63-
* **-c Advanced configuration**
63+
* **-c Advanced configuration**
6464
path to configuration file
6565

6666
# Advanced configuration
@@ -121,4 +121,4 @@ The input folder is recursively processed and each model file is read. When done
121121
```sh
122122
npm install && npm run build
123123
# output files generated in dist folder
124-
```
124+
```

0 commit comments

Comments
 (0)