Skip to content

Commit 90a6825

Browse files
committed
docs: adjust docs
1 parent f36f35e commit 90a6825

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
[bundlePhobiaBadge]: https://img.shields.io/bundlephobia/minzip/vue-modern-cropper
1212
[bundlePhobiaUrl]: https://bundlephobia.com/package/vue-modern-cropper@latest
1313

14+
> It's mid 2024, I've been searching, installing, and trying all, everything, but I can't find a maintained/bug-free, easy to use cropper component library for Vue -- (╯°□°)╯︵ ┻━┻
15+
So I created this.
16+
1417
> Power-packed wrapper over cropperjs@next
1518
1619
## Table of Contents
@@ -22,6 +25,7 @@
2225
- [Vue Modern Cropper](#vue-modern-cropper)
2326
- [Table of Contents](#table-of-contents)
2427
- [NOTE!!](#note)
28+
- [Features](#features)
2529
- [Usage](#usage)
2630
- [Install](#install)
2731
- [Use](#use)
@@ -30,11 +34,14 @@
3034
</details>
3135

3236
## NOTE!!
33-
`vue-modern-cropper` uses `cropperjs` (v2), you can check it's documentation [HERE](https://fengyuanchen.github.io/cropperjs/)
37+
`vue-modern-cropper` is a small wrapper over `cropperjs` (v2), improving ease of use and DX, while still preversing it's full customizability power, you can check it's documentation [HERE](https://fengyuanchen.github.io/cropperjs/)
3438

3539
At its current state, `cropperjs` is not SSR-friendly, though, even if it's SSR-able, I think it would be better to render it client-only to avoid overhead on the server, so remember to wrap/mark the component as `ClientOnly` if your project have SSR-enabled.
3640

37-
Feel free to submit PRs to add helper functions 😘.
41+
Feel free to submit PRs to improve DX even more 😘.
42+
43+
## Features
44+
+ 🔥 Import and use, typed component with discriminated union support
3845

3946
## Usage
4047
### Install

docs/App.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ onMounted(async () => {
115115
<div class="py-4 text-xl text-slate-700 font-semibold italic dark:text-slate-200">
116116
<p>Why "modern cropper"?</p>
117117
<p>
118-
It's mid 2024, I been searching, installing, trying all everything and can't find a maintained/bug-free,
118+
It's mid 2024, I've been searching, installing, and trying all, everything, but I can't find a maintained/bug-free,
119119
easy to use cropper component library for Vue -- <span class="whitespace-nowrap">(╯°□°)╯︵ ┻━┻</span>
120120
</p>
121121
<p>So I created this.</p>

0 commit comments

Comments
 (0)