Skip to content

Commit aa8cc10

Browse files
authored
docs: fix typos and improve clarity in README.md (#165)
1 parent 2c5c7ee commit aa8cc10

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@
1313

1414
# exports-loader
1515

16-
Allow to setup exports `module.exports`/`export` for source files.
16+
Allows you to set up exports using `module.exports` or `export` for source files.
1717

18-
Useful when a source file does not contain exports or something does not export.
18+
Useful when a source file does not contain exports or when something is not exported.
1919

20-
For further hints on compatibility issues, check out [Shimming](https://webpack.js.org/guides/shimming/) of the official docs.
20+
For more information on compatibility issues, refer to the [Shimming](https://webpack.js.org/guides/shimming/) guide in the official documentation.
2121

2222
> [!WARNING]
2323
>
24-
> By default loader generate ES module named syntax.
24+
> By default, the loader generates exports using ES module syntax.
2525
2626
> [!WARNING]
2727
>
28-
> Be careful, existing exports (`export`/`module.exports`/`exports`) in the original code and exporting new values can cause a failure.
28+
> Be careful: modifying existing exports (`export`, `module.exports`, or `exports`) or adding new exports can lead to errors.
2929
3030
## Getting Started
3131

@@ -54,7 +54,7 @@ The documentation and syntax examples can be read [here](#syntax).
5454

5555
> [!WARNING]
5656
>
57-
> `%20` is space in a query string, because you can't use spaces in URLs
57+
> `%20` represents a space in a query string because spaces are not allowed in URLs.
5858
5959
Then add the loader to the desired `import` statement or `require` calls. For example:
6060

@@ -150,7 +150,7 @@ import { myFunctionAlias } from "exports-loader?exports=named|myFunction|myFunct
150150
myFunctionAlias("Hello world");
151151
```
152152

153-
Description of string values can be found in the documentation below.
153+
Descriptions of string values can be found in the documentation below.
154154

155155
### Using Configuration
156156

@@ -174,7 +174,7 @@ module.exports = {
174174
};
175175
```
176176

177-
And run `webpack` via your preferred method.
177+
Finally, run `webpack` using the method you normally use (e.g., via CLI or an npm script).
178178

179179
## Options
180180

@@ -576,7 +576,7 @@ Allow to specify multiple exports. Each item can be a [`string`](https://github.
576576

577577
> [!WARNING]
578578
>
579-
> Not possible to use `single` and `multiple` syntaxes together due to CommonJS format limitations.
579+
> Not possible to use both `single` and `multiple` syntaxes together due to CommonJS format limitations.
580580
581581
> [!WARNING]
582582
>
@@ -686,7 +686,8 @@ export { Foo as FooA, Bar, Baz };
686686

687687
## Contributing
688688

689-
Please take a moment to read our contributing guidelines if you haven't yet done so.
689+
We welcome all contributions!
690+
If you're new here, please take a moment to review our contributing guidelines.
690691

691692
[CONTRIBUTING](./.github/CONTRIBUTING.md)
692693

0 commit comments

Comments
 (0)