Skip to content

Commit 4325ad5

Browse files
coryhousetleunen
authored andcommitted
docs: Grammar fixes (#135)
1 parent d84b6c2 commit 4325ad5

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# babel-plugin-module-resolver
22
[![Maintenance Status][status-image]][status-url] [![NPM version][npm-image]][npm-url] [![Build Status Linux][circleci-image]][circleci-url] [![Build Status Windows][appveyor-image]][appveyor-url] [![Coverage Status][coverage-image]][coverage-url]
33

4-
A [babel](http://babeljs.io) plugin to add a new resolver for your modules when compiling your code using Babel. The plugin allows you to add new "root" directories that contains your modules. It also allows you to setup custom alias which can also be directories or specific files, or even other npm modules.
4+
A [Babel](http://babeljs.io) plugin to add a new resolver for your modules when compiling your code using Babel. This plugin allows you to add new "root" directories that contain your modules. It also allows you to setup a custom alias for directories, specific files, or even other npm modules.
55

66
## Description
77

8-
The reason of this plugin is to simplify the require/import paths in your project. Therefore, instead of using complex relative paths like `../../../../utils/my-utils`, you would be able to write `utils/my-utils`. It will allow you to work faster since you won't need to calculate how many levels of directory you have to go up before accessing the file.
8+
This plugin can simplify the require/import paths in your project. For example, instead of using complex relative paths like `../../../../utils/my-utils`, you can write `utils/my-utils`. It will allow you to work faster since you won't need to calculate how many levels of directory you have to go up before accessing the file.
99

1010
```js
1111
// Use this:
@@ -57,7 +57,7 @@ Specify the plugin in your `.babelrc` with the custom root or alias. Here's an e
5757

5858
babel-plugin-module-resolver is a new version of the old babel-plugin-module-alias. Therefore, you also need to make a few modifications to your plugin configuration to make it work with this new plugin.
5959

60-
Updating is very easy, so for example if you had this configuration:
60+
Updating is very easy. For example, if you had this configuration:
6161
```json
6262
// This configuration is outdated, this is just an example
6363
{
@@ -87,11 +87,11 @@ You only have to update the plugin options to be like this:
8787

8888
## ESLint plugin
8989

90-
If you're using ESLint, you should use the [eslint-plugin-import][eslint-plugin-import], and this [eslint-import-resolver-babel-module][eslint-import-resolver-babel-module] in order to remove falsy unresolved modules.
90+
If you're using ESLint, you should use [eslint-plugin-import][eslint-plugin-import], and [eslint-import-resolver-babel-module][eslint-import-resolver-babel-module] to remove falsy unresolved modules.
9191

9292
## Usage with Flow
9393

94-
To allow Flow to find your modules it is necessary to add configuration options
94+
To allow Flow to find your modules, add configuration options
9595
to `.flowconfig`.
9696

9797
For example, a React component is located at `src/components/Component.js`
@@ -104,7 +104,7 @@ import '../../src/components/Component';
104104
import 'components/Component';
105105
```
106106

107-
You need to instruct Flow where to resolve modules from:
107+
Instruct Flow where to resolve modules from:
108108

109109
```
110110
# .flowconfig

0 commit comments

Comments
 (0)