Skip to content

Commit e08016e

Browse files
committed
docs: replace npm examples by yarn
1 parent 9e0cc4d commit e08016e

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Stream Utils
1+
# Web streams utils
22

3-
A TypeScript library providing utility functions for working with Web Streams
3+
A TypeScript library providing utility functions for working with the Web Stream
44
API.
55

66
## Installation
77

88
```bash
9-
npm install stream-utils
9+
npm install web-streams-utils
1010
```
1111

1212
## Features
@@ -92,7 +92,7 @@ TypeDoc.
9292
To generate the documentation:
9393

9494
```bash
95-
npm run docs
95+
yarn docs
9696
```
9797

9898
The documentation will be available in the `docs/` directory.
@@ -117,7 +117,7 @@ yarn run test:coverage
117117
### Formatting
118118

119119
```bash
120-
npm run format
120+
yarn format
121121
```
122122

123123
### Committing Changes
@@ -126,7 +126,7 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/)
126126
for commit messages. You can use the following command to create a commit:
127127

128128
```bash
129-
npm run commit
129+
yarn commit
130130
```
131131

132132
### Releasing

yarn.lock

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7451,30 +7451,6 @@ __metadata:
74517451
languageName: node
74527452
linkType: hard
74537453

7454-
"stream-utils@workspace:.":
7455-
version: 0.0.0-use.local
7456-
resolution: "stream-utils@workspace:."
7457-
dependencies:
7458-
"@commitlint/cli": "npm:^17.6.7"
7459-
"@commitlint/config-conventional": "npm:^17.6.7"
7460-
"@semantic-release/changelog": "npm:^6.0.3"
7461-
"@semantic-release/git": "npm:^10.0.1"
7462-
"@vitest/coverage-v8": "npm:^3.1.1"
7463-
commitizen: "npm:^4.3.0"
7464-
cz-conventional-changelog: "npm:^3.3.0"
7465-
husky: "npm:^8.0.3"
7466-
lint-staged: "npm:^13.2.3"
7467-
pkgroll: "npm:^1.10.0"
7468-
prettier: "npm:^3.0.0"
7469-
rimraf: "npm:^6.0.1"
7470-
semantic-release: "npm:^21.0.7"
7471-
typedoc: "npm:^0.24.8"
7472-
typedoc-plugin-markdown: "npm:^3.15.4"
7473-
typescript: "npm:^5.8.3"
7474-
vitest: "npm:^0.34.0"
7475-
languageName: unknown
7476-
linkType: soft
7477-
74787454
"string-argv@npm:0.3.2":
74797455
version: 0.3.2
74807456
resolution: "string-argv@npm:0.3.2"
@@ -8291,6 +8267,30 @@ __metadata:
82918267
languageName: node
82928268
linkType: hard
82938269

8270+
"web-streams-utils@workspace:.":
8271+
version: 0.0.0-use.local
8272+
resolution: "web-streams-utils@workspace:."
8273+
dependencies:
8274+
"@commitlint/cli": "npm:^17.6.7"
8275+
"@commitlint/config-conventional": "npm:^17.6.7"
8276+
"@semantic-release/changelog": "npm:^6.0.3"
8277+
"@semantic-release/git": "npm:^10.0.1"
8278+
"@vitest/coverage-v8": "npm:^3.1.1"
8279+
commitizen: "npm:^4.3.0"
8280+
cz-conventional-changelog: "npm:^3.3.0"
8281+
husky: "npm:^8.0.3"
8282+
lint-staged: "npm:^13.2.3"
8283+
pkgroll: "npm:^1.10.0"
8284+
prettier: "npm:^3.0.0"
8285+
rimraf: "npm:^6.0.1"
8286+
semantic-release: "npm:^21.0.7"
8287+
typedoc: "npm:^0.24.8"
8288+
typedoc-plugin-markdown: "npm:^3.15.4"
8289+
typescript: "npm:^5.8.3"
8290+
vitest: "npm:^0.34.0"
8291+
languageName: unknown
8292+
linkType: soft
8293+
82948294
"which@npm:^1.2.14":
82958295
version: 1.3.1
82968296
resolution: "which@npm:1.3.1"

0 commit comments

Comments
 (0)