Skip to content

Commit 7319161

Browse files
authored
docs: fix typos and improve clarity in README.md (#234)
1 parent 2b75ff9 commit 7319161

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22
<a href="https://webpack.js.org/">
3-
<img width="200" height="200" vspace="" hspace="25" src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon-square-big.svg">
3+
<img width="200" height="200" hspace="25" src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon-square-big.svg">
44
</a>
55
</div>
66

@@ -13,7 +13,7 @@
1313

1414
# thread-loader
1515

16-
Runs the following loaders in a worker pool.
16+
Runs the specified loaders in a worker pool.
1717

1818
## Getting Started
1919

@@ -33,17 +33,18 @@ or
3333
pnpm add -D thread-loader
3434
```
3535

36-
Put this loader in front of other loaders. The following loaders run in a worker pool.
36+
Put this loader in front of other loaders.
37+
The following loaders run in a worker pool.
3738

38-
Loaders running in a worker pool are limited. Examples:
39+
Loaders running in a worker pool have limitations. Examples:
3940

4041
- Loaders cannot emit files.
41-
- Loaders cannot use custom loader API (i. e. by plugins).
42-
- Loaders cannot access the webpack options.
42+
- Loaders cannot use custom loader APIs (i.e. by plugins).
43+
- Loaders cannot access webpack options.
4344

44-
Each worker is a separate node.js process, which has an overhead of ~600ms. There is also an overhead of inter-process communication.
45+
Each worker is a separate Node.js process, which has an overhead of ~600ms. There is also additional overhead from inter-process communication.
4546

46-
Use this loader only for expensive operations!
47+
> Use this loader only for expensive operations!
4748
4849
### Examples
4950

@@ -97,11 +98,11 @@ use: [
9798

9899
// number of jobs the pool distributes to the workers
99100
// defaults to 200
100-
// decrease of less efficient but more fair distribution
101+
// decrease for less efficient but more fair distribution
101102
poolParallelJobs: 50,
102103

103104
// name of the pool
104-
// can be used to create different pools with elsewise identical options
105+
// can be used to create different pools with otherwise identical options
105106
name: 'my-pool',
106107
},
107108
},
@@ -111,9 +112,9 @@ use: [
111112

112113
**prewarming**
113114

114-
To prevent the high delay when booting workers it possible to warmup the worker pool.
115+
To prevent the high delays when booting workers, it is possible to warm up the worker pool.
115116

116-
This boots the max number of workers in the pool and loads specified modules into the node.js module cache.
117+
This boots the max number of workers in the pool and loads the specified modules into the Node.js module cache.
117118

118119
```js
119120
const threadLoader = require('thread-loader');
@@ -125,17 +126,18 @@ threadLoader.warmup(
125126
},
126127
[
127128
// modules to load
128-
// can be any module, i. e.
129+
// can be any module, i.e.
129130
'babel-loader',
130-
'babel-preset-es2015',
131+
'@babel/preset-env',
131132
'sass-loader',
132133
],
133134
);
134135
```
135136

136137
## Contributing
137138

138-
Please take a moment to read our contributing guidelines if you haven't yet done so.
139+
We welcome all contributions!
140+
If you're new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.
139141

140142
[CONTRIBUTING](./.github/CONTRIBUTING.md)
141143

0 commit comments

Comments
 (0)