Skip to content

Commit ccce90b

Browse files
authored
docs: fixed typos (#5)
1 parent 3ada194 commit ccce90b

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ to the user.
2020

2121
## Variables
2222

23-
| Name | Description | Default value |
24-
| ------|------------------|-------------- |
25-
|`project_title`| The title of the project | value on the `pubspec.yaml`|
26-
| `project_description`| The project description |`name` attribute in the `pubspec.yaml`|
27-
| `batch_size`| How match assets will be loaded at the same time | `20`|
28-
| `canvaskit`| If the app uses `canvaskit` mode or not |`true`|
23+
| Name | Description | Default value |
24+
| --------------------- | ----------------------------------------------- | --------------------------------------------- |
25+
| `project_title` | The title of the project | `name` attribute in the `pubspec.yaml` |
26+
| `project_description` | The project description | `description` attribute in the `pubspec.yaml` |
27+
| `batch_size` | How many assets will be loaded at the same time | `20` |
28+
| `canvaskit` | If the app uses `canvaskit` mode or not | `true` |
2929

3030
## FAQ
3131

@@ -35,22 +35,27 @@ Yes, the progress bar can be customized. The generated `web/index.html` has a co
3535
For example, we can change the `background-color` to red by doing:
3636

3737
```html
38-
<div id="progress-bar" style="border: 1px solid blue; width: 250px; height: 50px;">
39-
<div id="progress-indicator" style="background-color: red; height: 100%; width: 0%;"></div>
40-
</div>
38+
<div
39+
id="progress-bar"
40+
style="border: 1px solid blue; width: 250px; height: 50px;"
41+
>
42+
<div
43+
id="progress-indicator"
44+
style="background-color: red; height: 100%; width: 0%;"
45+
></div>
46+
</div>
4147
```
4248

4349
### What would be the optimal `batch_size`?
4450

45-
The `batch_size` depends on the number and average size of your assets.
51+
The `batch_size` depends on the number and average size of your assets.
4652

47-
The `batch_size` can be increased when the average size of the assets is small, since the requests will finish sooner. However, keep in mind that a large `batch_size` may trigger too many requests at the same time and it may cause unexpected issues in the browser.
53+
The `batch_size` can be increased when the average size of the assets is small, since the requests will finish sooner. However, keep in mind that a large `batch_size` may trigger too many requests at the same time and it may cause unexpected issues in the browser.
4854
On the other hand, the `batch_size` should be decreased when the size of the assets are large.
4955

5056
The default `batch_size` is `20`, this should be a good number for most projects. It is not too high to cause unexpected browser issues, but also not low enough to cause the loading to take too much time.
5157

5258
In any case, we advise on testing when changing this value to make sure that it
5359
won't break your app.
5460

55-
5661
[1]: https://github.com/felangel/mason

0 commit comments

Comments
 (0)