Skip to content

Commit 8f3878a

Browse files
GalacticHypernovaNorserium
GalacticHypernova
authored and
Norserium
committed
docs: Grammar overhaul for the master branch
1 parent a52b56e commit 8f3878a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Diff for: ‎README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@
1515

1616
---
1717

18-
:fire: **HEADS UP!** You're currently looking at the branch for Vue 2. If you're looking for the branch for Vue 3, [please check out `vue-next` branch](https://github.com/advanced-cropper/vue-advanced-cropper/tree/vue-next).
18+
:fire: **HEADS UP!** You're currently looking at the branch for Vue 2. For the Vue 3 branch, [please check out the `vue-next` branch](https://github.com/advanced-cropper/vue-advanced-cropper/tree/vue-next).
1919

2020
---
2121

22-
**Vue Advanced Cropper** is the advanced library that gives you opportunity to create your own croppers suited for any website design.
23-
It means that you are able to change not only the cropper appearance, you area able to customize its behavior also.
22+
**Vue Advanced Cropper** is the advanced library that allows you to create custom croppers suited for any website design.
23+
It means that you can change not only the cropper's appearance but also its behavior.
2424

2525
Features:
2626

27-
- full mobile / desktop support
27+
- full mobile/desktop support
2828
- support [all three main types of croppers](https://advanced-cropper.github.io/vue-advanced-cropper/introduction/types.html) right out of the box
2929
- support both canvas and coordinates modes, minimum and maximum aspect ratios, custom size restrictions
3030
- zoom, rotate, resize image
@@ -56,7 +56,7 @@ npm install --save vue-advanced-cropper@vue-2
5656
yarn add vue-advanced-cropper@vue-2
5757
```
5858

59-
If you would to use CDN read the corresponding [documentation section](https://advanced-cropper.github.io/vue-advanced-cropper/introduction/getting-started.html#using-cdn)
59+
If you would like to use a CDN, please read the corresponding [documentation section](https://advanced-cropper.github.io/vue-advanced-cropper/introduction/getting-started.html#using-cdn)
6060

6161
## Usage
6262

@@ -96,8 +96,8 @@ new Vue({
9696

9797
```
9898
/*
99-
Maybe you need to set the limits for the cropper sizes or its container sizes
100-
otherwise a cropping image will try to fill all available space
99+
You may need to set the limits for the cropper sizes or container sizes,
100+
otherwise, a cropping image will try to fill all available space
101101
*/
102102
.cropper {
103103
height: 600px;
@@ -120,7 +120,7 @@ new Vue({
120120
| autoZoom | `Boolean` | Enable / disable transitions | `false`
121121
| transitions | `Boolean` | Enable / disable auto zoom | `true`
122122
| stencilSize | `Object ` | The size of the stencil in pixels |
123-
| debounce | `String`, `Number` | The time before change event will be emitted after changes (ms) | `500`
123+
| debounce | `String`, `Number` | The time before the `change` event will be emitted after changes (ms) | `500`
124124
| canvas | `Boolean` | The flag that indicates if canvas should be used | `true`
125125
| minWidth | `String`, `Number` | The minimum width of the stencil (percents) |
126126
| minHeight | `String`, `Number` | The minimum height of the stencil (percents) |
@@ -138,9 +138,9 @@ new Vue({
138138

139139
| Event | Description
140140
| ------------------------ | --------------------------------------------------------------
141-
| change | Invoked on changing of a stencil position / size, after mounting the component and on an image changing
142-
| ready | Invoked on success of an image loading
143-
| error | Invoked on error of an image loading
141+
| change | Invoked on the changing of a stencil's position/size after mounting the component and on an image change
142+
| ready | Invoked on the success of an image loading
143+
| error | Invoked on an error of an image loading
144144

145145

146146
## RectangleStencil
@@ -150,20 +150,20 @@ new Vue({
150150
| aspectRatio | `Number` | The aspect ratio |
151151
| minAspectRatio | `Number` | The minimum aspect ratio |
152152
| maxAspectRatio | `Number` | The maximum aspect ratio |
153-
| class | `String` | The class for root block of the stencil component |
153+
| class | `String` | The class for the root block of the stencil component |
154154
| previewClass | `String` | The class for the preview component |
155-
| movingClass | `String` | The class applied when user drag the stencil |
156-
| resizingClass | `String` | The class applied when user resize the stencil |
155+
| movingClass | `String` | The class applied when the user drags the stencil |
156+
| resizingClass | `String` | The class applied when the user resizes the stencil |
157157
| boundingBoxClass | `String` | The class for the bounding box component |
158158
| handlerComponent | `String`,`Object` | The handler component |
159159
| handlers | `Object` | The object of handlers that should be visible or hidden. |
160160
| handlersClasses | `Object` | The object of custom handler classes |
161161
| handlersWrappersClasses | `Object` | The object of custom handler wrapper classes |
162162
| lineComponent | `String`,`Object` | The handler component |
163-
| lines | `Object` | The object of lines that should be visible or hidden. |
163+
| lines | `Object` | The object of the lines that should be visible or hidden. |
164164
| linesClasses | `Object` | The object of custom line classes |
165165
| linesWrappersClasses | `Object` | The object of custom line wrapper classes |
166166

167167
## License
168168

169-
The source code of this library is licensed under MIT, the documentation and photos are belong to their respective owners.
169+
The source code of this library is licensed under the MIT license, and the documentation and photos belong to their respective owners.

0 commit comments

Comments
 (0)