Skip to content

Commit aa33384

Browse files
authored
docs(readme): fix typos, improve clarity
1 parent 0ba0655 commit aa33384

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ A simple integration to run [solid-js](https://github.com/solidjs/solid) with [v
88

99
<img alt="HMR gif demonstrationdemodemodemo" src=".github/hmr.gif">
1010

11-
# Got a question? / Need help?
11+
# Have a question? / Need help?
1212

13-
Join [solid discord](https://discord.com/invite/solidjs) and check the [troubleshooting section](#troubleshooting) to see if your question hasn't been already answered.
13+
Join [solid discord](https://discord.com/invite/solidjs) and check the [troubleshooting section](#troubleshooting) to see if your question has already been answered.
1414

1515
## Features
1616

@@ -24,7 +24,7 @@ Join [solid discord](https://discord.com/invite/solidjs) and check the [troubles
2424

2525
This module 100% ESM compatible and requires NodeJS `14.18.0` or later.
2626

27-
You can check your current version of NodeJS by typing `node -v` in your terminal. If your version is below that one version I'd encourage you to either do an update globally or use a NodeJS version management tool such as [Volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm).
27+
You can check your current version of NodeJS by typing `node -v` in your terminal. If your version is below that one version we encourage you to either do an update globally or use a NodeJS version management tool such as [Volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm).
2828

2929
## Quickstart
3030

@@ -158,20 +158,20 @@ Pass any additional [@babel/preset-typescript](https://babeljs.io/docs/en/babel-
158158
- Default: []
159159

160160
An array of custom extension that will be passed through the solid compiler.
161-
By default, the plugin only transform `jsx` and `tsx` files.
161+
By default, the plugin only transforms `jsx` and `tsx` files.
162162
This is useful if you want to transform `mdx` files for example.
163163

164164
## Note on HMR
165165

166-
Starting from version `1.1.0`, this plugin handle automatic HMR via [solid-refresh](https://github.com/solidjs/solid-refresh).
166+
Starting from version `1.1.0`, this plugin handles automatic HMR via [solid-refresh](https://github.com/solidjs/solid-refresh).
167167

168-
At this stage it's still early work but provide basic HMR. In order to get the best out of it there are couple of things to keep in mind:
168+
At this stage it's still early work but basic HMR is provided. In order to get the best out of it there are couple of things to keep in mind:
169169

170170
- When you modify a file every state below this component will be reset to default state (including the current file). The state in parent component is preserved.
171171

172172
- The entrypoint can't benefit from HMR yet and will force a hard reload of the entire app. This is still really fast thanks to browser caching.
173173

174-
If at least one of this point is blocking to you, you can revert to the old behavior by [opting out the automatic HMR](#options) and placing the following snippet in your entry point:
174+
If at least one of these points is blocking for you, you can revert to the old behavior by [opting out the automatic HMR](#options) and placing the following snippet in your entry point:
175175

176176
```jsx
177177
const dispose = render(() => <App />, document.body);
@@ -184,23 +184,23 @@ if (import.meta.hot) {
184184
185185
# Troubleshooting
186186
187-
- It appears that Webstorm generate some weird triggers when saving a file. In order to prevent that you can follow [this thread](https://intellij-support.jetbrains.com/hc/en-us/community/posts/360000154544-I-m-having-a-huge-problem-with-Webstorm-and-react-hot-loader-) and disable the **"Safe Write"** option in **"Settings | Appearance & Behavior | System Settings"**.
187+
- It appears that Webstorm generates some weird triggers when saving a file. In order to prevent that you can follow [this thread](https://intellij-support.jetbrains.com/hc/en-us/community/posts/360000154544-I-m-having-a-huge-problem-with-Webstorm-and-react-hot-loader-) and disable the **"Safe Write"** option in **"Settings | Appearance & Behavior | System Settings"**.
188188
189-
- If one of your dependency spit out React code instead of Solid that means that they don't expose JSX properly. To get around it, you might want to manually exclude it from the [dependencies optimization](https://vitejs.dev/config/dep-optimization-options.html#optimizedeps-exclude)
189+
- If one of your dependencies ouputs React code instead of Solid that means that it doesn't expose JSX properly. To get around it, you might want to manually exclude it from the [dependencies optimization](https://vitejs.dev/config/dep-optimization-options.html#optimizedeps-exclude)
190190
191-
- If you are trying to make [directives](https://www.solidjs.com/docs/latest/api#use%3A___) work, and they somehow don't try setting the `options.typescript.onlyRemoveTypeImports` option to `true`
191+
- If you are trying to make [directives](https://www.solidjs.com/docs/latest/api#use%3A___) workand they somehow don't try setting the `options.typescript.onlyRemoveTypeImports` option to `true`
192192
193193
## Migration from v1
194194
195-
The master branch now target vite 2.
195+
The main branch now targets vite 2.
196196
197-
The main breaking change from previous version is that the package has been renamed from `@amoutonbrady/vite-plugin-solid` to `vite-plugin-solid`.
197+
The primary breaking change from the previous version is that the package has been renamed from `@amoutonbrady/vite-plugin-solid` to `vite-plugin-solid`.
198198
199199
For other breaking changes, check [the migration guide of vite](https://vitejs.dev/guide/migration.html).
200200
201201
# Testing
202202
203-
If you are using [vitest](https://vitest.dev/), this plugin already injects the necessary configuration for you. It even automatically detects if you have `@testing-library/jest-dom` installed in your project and automatically adds it to the `setupFiles`. All you need to add (if you want) is `globals`, `coverage`, and other testing configuration of your choice. If you can live without those, enjoy using vitest without the need to configure it yourself.
203+
If you are using [vitest](https://vitest.dev/), this plugin already injects the necessary configuration for you. It even automatically detects if you have `@testing-library/jest-dom` installed in your project and automatically adds it to the `setupFiles`. You can optionally add `globals`, `coverage`, and other testing configurations of your choice. If you can live without those, enjoy using vitest without the need to configure it yourself.
204204
205205
# Credits
206206

0 commit comments

Comments
 (0)