Skip to content

Commit

Permalink
chore: add documentation regarding restriction of npm create command (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
kpanot authored Jan 29, 2024
2 parents 03d190f + b028beb commit cbe8d03
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
12 changes: 9 additions & 3 deletions packages/@ama-sdk/create/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,24 @@ This package is simplifying the start of new SDK repository.

## Usage

### NPM

```shell
npm create @ama-sdk typescript <package-name> -- [...options]
```

### Yarn
or

```shell
yarn create @ama-sdk typescript <project-name> [...options]
```

> **Warning** : Please notice that the command `yarn create` is **not** available for versions *>= 2.0.0* (see [Yarn cli commands](https://yarnpkg.com/cli)).
You can generate an environment with a specific package manager thanks to the `--package-manager` options:

```shell
npm create @ama-sdk typescript <project-name> -- --package-manager=yarn [...options]
```

## Options list

- `--spec-path`: Path to the swagger/open-api specification used to generate the SDK
Expand Down
4 changes: 3 additions & 1 deletion packages/@ama-sdk/create/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@
"type-fest": "^4.3.1"
},
"engines": {
"node": ">=18.0.0"
"node": ">=18.0.0",
"yarn": "<2.0.0",
"npm": "*"
}
}
12 changes: 9 additions & 3 deletions packages/@o3r/create/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,20 @@ This package is simplifying the start of an [Otter Framework](https://github.com

## Usage

### NPM

```shell
npm create @o3r <project-name> -- [...options]
```

### Yarn
or

```shell
yarn create @o3r <project-name> [...options]
```

> **Warning** : Please notice that the command `yarn create` is **not** available for versions *>= 2.0.0* (see [Yarn cli commands](https://yarnpkg.com/cli)).
You can generate an environment with a specific package manager thanks to the `--package-manager` options:

```shell
npm create @o3r <project-name> -- --package-manager=yarn [...options]
```
4 changes: 3 additions & 1 deletion packages/@o3r/create/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@
"typescript": "~5.2.2"
},
"engines": {
"node": ">=18.0.0"
"node": ">=18.0.0",
"yarn": "<2.0.0",
"npm": "*"
}
}

0 comments on commit cbe8d03

Please sign in to comment.