Skip to content

Commit 1523c37

Browse files
authored
apply readme comments
1 parent eb7bf8f commit 1523c37

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Almost all projects need to have a router, a UI framework, store integration, th
4444

4545
#### Vite
4646

47-
[Vite](https://vitejs.dev/) is a blazingly fast build tool based on [native ES modules](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/), [rollup](https://rollupjs.org/guide/en/), and [esbuild](https://esbuild.github.io/). `React-PWA` v1 was based on [CRA](https://reactjs.org/docs/create-a-new-react-app.html). We still love `CRA` and really think it's a great tool, but `Vite` provides a much better developer experience and it's unconditionally faster (maybe, we will also create a CRA version of `React-PWA` v2 in near future).
47+
[Vite](https://vitejs.dev/) is a blazingly fast build tool based on [native ES modules](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/), [rollup](https://rollupjs.org/guide/en/), and [esbuild](https://esbuild.github.io/). `React-PWA` v1 was based on [CRA](https://reactjs.org/docs/create-a-new-react-app.html). We still love `CRA` and really think it's a great tool, but `Vite` provides a much better developer experience and it's unconditionally faster (maybe, we will also create a `CRA` version of `React-PWA` v2 in near future).
4848

4949
#### React
5050

@@ -54,7 +54,7 @@ The latest version (v18) is used here. All dependencies support [React](https://
5454

5555
"Not using [TypeScript](https://www.typescriptlang.org/) is like driving without a seatbelt" - [Matt Howard](https://twitter.com/MattDotHow).
5656

57-
For those who do not familiar with `TypeScript` - don't worry, you will love it, as we all did. `TypeScript` is a superset of `JavaScript`; it should be very easy to work with if you know `JavaScript`.
57+
For those who are not familiar with `TypeScript` - don't worry, you will love it, as we all did. `TypeScript` is a superset of `JavaScript`; it should be very easy to work with if you know `JavaScript`.
5858

5959
#### Router
6060

@@ -79,7 +79,7 @@ function MyCoolComponent() {
7979
const [notifications, actions] = useNotification();
8080

8181
function showNotification() {
82-
actions.push({ message: 'Բարև կարմիր արև' });
82+
actions.push({ message: 'Բարև, կարմի՛ր արև' });
8383
}
8484

8585
return (
@@ -103,7 +103,7 @@ function MyCoolComponent() {
103103
// check the current theme mode
104104
console.log(theme);
105105

106-
// if you want to change the theme, call appropriate action
106+
// if you want to change the theme, call an appropriate action
107107
function toggleTheme() {
108108
actions.toggle();
109109
}
@@ -135,7 +135,7 @@ Also, you can redefine the theme in the theme configuration file. Check the [src
135135

136136
#### Base file/folder structure
137137

138-
Here how looks the base file/folder structure:
138+
Here how the base file/folder structure looks like:
139139

140140
<img src="./public/file-folder-structure.png" title="file folder structure">
141141

@@ -151,7 +151,7 @@ Your users will also be informed about the new version of your app:
151151

152152
#### Performance
153153

154-
After all these integrations the biggest bundle size is `~79KB`. It means even the first load will be pretty fast (in my case it's `1.1s`), further loads (already cached by `service worker` and `workbox`) and will take `~0.25s`.
154+
After all these integrations the biggest bundle size is `~79KB`. It means even the first load will be pretty fast (in my case it's `1.1s`), further loads (already cached by `service worker` and `workbox`) will take `~0.25s`.
155155

156156
<img src="./public/bundle.png" title="bundle">
157157

@@ -161,7 +161,7 @@ NOTE: The performance is not 100 because it's running on demo server.
161161

162162
#### Hotkeys
163163

164-
A basic implementation of hotkeys is demonstrated. Check the [src/sections/HotKeys](./src/sections/HotKeys/HotKeys.tsx) for more information.
164+
A basic implementation of hotkeys is demonstrated here. Check the [src/sections/HotKeys](./src/sections/HotKeys/HotKeys.tsx) for more information.
165165

166166
Currently, you can use the following hotkeys:
167167

@@ -175,7 +175,7 @@ Nobody likes white screens and crashes without any notes. In [src/error-handling
175175

176176
#### Pages
177177

178-
From a layout point of view the application is consists of 3 main parts:
178+
From a layout point of view the application consists of 3 main parts:
179179

180180
- Header
181181
- Sidebar
@@ -207,7 +207,7 @@ The last one is a router-based switcher. All routes are defined in [src/routes](
207207

208208
You can use it to lint your commit messages, run tests, lint code, etc.
209209

210-
Currently, only `pre-commit` hook is setup. Every time you try to do a commit it will run `prettier` and `eslint` to be sure if everything is according to the rules.
210+
Currently, only `pre-commit` hook is set up. Every time you try to do a commit it will run `prettier` and `eslint` to be sure that everything is according to the rules.
211211

212212
- [lint-staged](https://github.com/okonet/lint-staged)
213213

@@ -235,7 +235,7 @@ The last one is a router-based switcher. All routes are defined in [src/routes](
235235

236236
## Usage
237237

238-
You can use this template just by pressing `Use this temaplte`.
238+
You can use this template by just pressing `Use this temaplte`.
239239

240240
<img src="./public/use-template.png" width="300" title="Use this temaplte">
241241

0 commit comments

Comments
 (0)