Skip to content

Commit

Permalink
chore: update readme and some typescript issues (#52)
Browse files Browse the repository at this point in the history
* chore: update readme and some typescript issues

* Create eleven-games-change.md

Signed-off-by: Alexandre BODIN <[email protected]>

* Update README.md

Co-authored-by: Ben Irvin <[email protected]>
Signed-off-by: Alexandre BODIN <[email protected]>

---------

Signed-off-by: Alexandre BODIN <[email protected]>
Co-authored-by: Ben Irvin <[email protected]>
  • Loading branch information
alexandrebodin and innerdvations committed Sep 12, 2024
1 parent 45a15fe commit 374fd9a
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 71 deletions.
5 changes: 5 additions & 0 deletions .changeset/eleven-games-change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@strapi/sdk-plugin": patch
---

chore: update readme and some typescript issues
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ npx @strapi/sdk-plugin@latest init my-plugin

That will create a directory with all your plugin project files.

Once your project has been installed, you will have access to the `strapi-plugin` command.

Run `strapi-plugin -h` for more information on CLI usage.
Once your project has been installed, several commands are available to you.

## Commands

Expand All @@ -47,19 +45,35 @@ Creates a new plugin at the given path.

### `build`

Builds your current package based on the configuration in your `package.json` and `packup.config.ts` (if applicable).
Builds your current package based on the configuration in your `package.json`.

- `--minify` – minifies the output (default `false`).
- `--sourcemap` – generates sourcemaps for the output (default `true`).

```sh
yarn run build
```

### `watch`

Watch & compile your strapi plugin for local development.

```sh
yarn run watch
```

### `watch:link`

Recompiles your plugin automatically on changes and runs yalc push --publish

```sh
yarn run watch:link
```

### `verify`

Verifies the output of your plugin before publishing it

```sh
yarn run verify
```
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
"@swc/jest": "^0.2.36",
"@types/git-url-parse": "9.0.3",
"@types/jest": "^29.5.12",
"@types/node": "^22.5.4",
"@types/nodemon": "^1.19.6",
"@types/prettier": "^2.0.0",
"@typescript-eslint/eslint-plugin": "^7.6.0",
Expand Down
Loading

0 comments on commit 374fd9a

Please sign in to comment.