Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cpm): add @mheob/ scope to README #64

Merged
merged 1 commit into from
Sep 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/large-pillows-poke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@mheob/check-package-manager': patch
---

Add `@mheob/` scope to the scripts in the README
24 changes: 12 additions & 12 deletions packages/check-package-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ Use one of the examples.

```json
"scripts": {
"check-package-manager": "npx check-package-manager npm", // NPM
"check-package-manager": "yarn dlx check-package-manager yarn", // YARN
"check-package-manager": "yarn exec check-package-manager yarn", // YARN - locally installed
"check-package-manager": "pnpm dlx check-package-manager", // PNPM
"check-package-manager": "pnpm dlx check-package-manager pnpm", // PNPM - alternative
"check-package-manager": "pnpm exec check-package-manager", // PNPM - locally installed
"check-package-manager": "pnpm exec check-package-manager pnpm", // PNPM - alternative locally installed
"check-package-manager": "npx @mheob/check-package-manager npm", // NPM
"check-package-manager": "yarn dlx @mheob/check-package-manager yarn", // YARN
"check-package-manager": "yarn exec @mheob/check-package-manager yarn", // YARN - locally installed
"check-package-manager": "pnpm dlx @mheob/check-package-manager", // PNPM
"check-package-manager": "pnpm dlx @mheob/check-package-manager pnpm", // PNPM - alternative
"check-package-manager": "pnpm exec @mheob/check-package-manager", // PNPM - locally installed
"check-package-manager": "pnpm exec @mheob/check-package-manager pnpm", // PNPM - alternative locally installed
},
```

Expand All @@ -51,25 +51,25 @@ Use `npx` if you use `NPM` as package manager.\
Otherwise use `exec` if you have installed the package in your project, otherwise use `dlx`.

```sh
npx check-package-manager
npx @mheob/check-package-manager
```

#### `NPM`

```sh
npx check-package-manager npm
npx @mheob/check-package-manager npm
```

#### `YARN`

```sh
yarn dlx check-package-manager yarn
yarn dlx @mheob/check-package-manager yarn
```

#### `PNPM`

```sh
pnpm dlx check-package-manager pnpm
pnpm dlx @mheob/check-package-manager pnpm
```

### As git hook
Expand All @@ -82,5 +82,5 @@ For example used in combination with [husky](https://typicode.github.io/husky/).

[ -n "$CI" ] && exit 0

pnpm exec check-package-manager
pnpm dlx @mheob/check-package-manager
```