Skip to content

Commit 5ad255e

Browse files
authored
Update README.md (#450)
## Update README.md, NuGet README.md, Docs home page, update CI action
2 parents 2e3de8b + 5558a27 commit 5ad255e

File tree

4 files changed

+27
-44
lines changed

4 files changed

+27
-44
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ on:
99
pull_request:
1010
branches-ignore:
1111
- master
12+
paths-ignore:
13+
- '**.md'
1214

1315
permissions:
1416
contents: read

NuGet_README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## Cropper.Blazor is a component that wraps around Cropper.js version 1.6.2
22

3-
[![Build and run test](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/ci.yml)
4-
[![Deploy to GitHub Pages](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml)
53
[![Deploy to NuGet](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml)
4+
[![Deploy to GitHub Pages](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml)
65
[![coverage](https://codecov.io/github/CropperBlazor/Cropper.Blazor/branch/dev/graph/badge.svg?token=39M66DO85T)](https://codecov.io/github/CropperBlazor/Cropper.Blazor)
76
[![GitHub](https://img.shields.io/github/license/CropperBlazor/Cropper.Blazor?color=ff5c9b)](https://github.com/CropperBlazor/Cropper.Blazor/blob/dev/LICENSE)
87
[![GitHub](https://img.shields.io/github/last-commit/CropperBlazor/Cropper.Blazor?color=009DEA)](https://github.com/CropperBlazor/Cropper.Blazor)
98
[![NuGet Downloads](https://img.shields.io/nuget/dt/Cropper.Blazor?logo=nuget&label=nuget%20downloads&color=ff5c9b)](https://www.nuget.org/packages/Cropper.Blazor)
9+
[![NuGet Version](https://img.shields.io/nuget/v/Cropper.Blazor?logo=nuget&label=nuget%20version&color=009DEA)](https://www.nuget.org/packages/Cropper.Blazor)
1010

1111
The most powerful image cropping tool for Blazor WebAssembly / Server, Hybrid with MAUI, MVC and
1212
other frameworks.
@@ -25,13 +25,12 @@ Cropper.Blazor is an essential component for building interactive image cropping
2525
## Prerequisites
2626
| Cropper.Blazor | .NET | Support |
2727
| :--- | :---: | :---: |
28-
| - | .NET 3.1 | Not supported |
29-
| - | .NET 5 | Not supported |
28+
| - | .NET 3.1, .NET 5 | Not supported |
3029
| 1.1.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) | :heavy_check_mark: |
31-
| 1.2.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) | :heavy_check_mark: |
32-
| 1.3.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) & [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) | :heavy_check_mark: |
33-
| 1.4.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) & [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) & [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) | :heavy_check_mark: |
34-
| 1.5.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) & [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) & [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) & [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) | :heavy_check_mark: |
30+
| 1.2.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) | :heavy_check_mark: |
31+
| 1.3.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) | :heavy_check_mark: |
32+
| 1.4.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0), [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) | :heavy_check_mark: |
33+
| 1.5.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0), [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0), [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) | :heavy_check_mark: |
3534

3635
- Supported .NET 10.0, .NET 9.0, .NET 8.0, .NET 7.0, .NET 6.0 versions for these web platforms:
3736
- Blazor WebAssembly
@@ -72,7 +71,6 @@ Import Custom Element:
7271
@using Cropper.Blazor.Components
7372
```
7473

75-
7674
Add the following to `index.html` (client-side — Blazor Webassembly, Blazor MAUI) or `_Host.cshtml` (server-side — Blazor Server, MVC with Blazor Server) in the `head`
7775
```razor
7876
<link href="_content/Cropper.Blazor/cropper.min.css" rel="stylesheet" />
@@ -83,7 +81,6 @@ Add the following to `index.html` or `_Host.cshtml` in the `body`
8381
<script src="_content/Cropper.Blazor/cropper.min.js"></script>
8482
```
8583

86-
8784
Add the following to the relevant sections of `Program.cs`
8885
```c#
8986
using Cropper.Blazor.Extensions;
@@ -121,7 +118,6 @@ builder.Services.AddServerSideBlazor()
121118
app.MapBlazorHub();
122119
```
123120

124-
125121
And then use it in Razor file ([for example](https://github.com/CropperBlazor/Cropper.Blazor/blob/dev/src/Cropper.Blazor/Client/Pages/CropperDemo.razor)):
126122

127123
```razor
@@ -192,11 +188,3 @@ Definitely need to tell these rules in Blazor:
192188
```c#
193189
await JSRuntime!.InvokeVoidAsync("window.overrideCropperJsInteropModule", MinZoomRatio, MaxZoomRatio);
194190
```
195-
196-
## Contributing
197-
198-
1. Fork it!
199-
2. Create your feature branch: `git checkout -b feature/<my-new-feature>`
200-
3. Commit your changes: `git commit -m 'Add some feature'`
201-
4. Push to the branch: `git push origin feature/<my-new-feature>`
202-
5. Submit a pull request :D

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,48 +10,41 @@
1010
</p>
1111
</p>
1212

13-
[![Build and run test](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/ci.yml)
14-
[![Deploy to GitHub Pages](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml)
1513
[![Deploy to NuGet](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml)
14+
[![Deploy to GitHub Pages](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml/badge.svg?event=push)](https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml)
1615
[![coverage](https://codecov.io/github/CropperBlazor/Cropper.Blazor/branch/dev/graph/badge.svg?token=39M66DO85T)](https://codecov.io/github/CropperBlazor/Cropper.Blazor)
1716
[![GitHub](https://img.shields.io/github/license/CropperBlazor/Cropper.Blazor?color=ff5c9b)](https://github.com/CropperBlazor/Cropper.Blazor/blob/dev/LICENSE)
1817
[![GitHub](https://img.shields.io/github/last-commit/CropperBlazor/Cropper.Blazor?color=009DEA)](https://github.com/CropperBlazor/Cropper.Blazor)
1918
[![NuGet Downloads](https://img.shields.io/nuget/dt/Cropper.Blazor?logo=nuget&label=nuget%20downloads&color=ff5c9b)](https://www.nuget.org/packages/Cropper.Blazor)
19+
[![NuGet Version](https://img.shields.io/nuget/v/Cropper.Blazor?logo=nuget&label=nuget%20version&color=009DEA)](https://www.nuget.org/packages/Cropper.Blazor)
2020

2121
The most powerful image cropping tool for Blazor WebAssembly / Server, Hybrid with MAUI, MVC and
2222
other frameworks.
2323

2424
Cropper.Blazor is an essential component for building interactive image cropping and manipulation features in Blazor web applications. This versatile Blazor library empowers developers to integrate intuitive image cropping functionality directly into their Blazor projects, offering users a seamless and responsive image editing experience.
2525

26-
## Demo
27-
- [CropperBlazor.github.io/demo](https://CropperBlazor.github.io/demo)
28-
29-
## API
30-
- [CropperBlazor.github.io/api](https://cropperblazor.github.io/api)
31-
32-
## Examples
33-
- [CropperBlazor.github.io/examples/cropperusage](https://cropperblazor.github.io/examples/cropperusage)
26+
## 🌐 [Demo](https://CropperBlazor.github.io/demo) 📖 [API](https://cropperblazor.github.io/api) 💡 [Examples](https://cropperblazor.github.io/examples/cropperusage)
3427

3528
## Prerequisites
3629
| Cropper.Blazor | .NET | Support |
3730
| :--- | :---: | :---: |
38-
| - | .NET 3.1 | Not supported |
39-
| - | .NET 5 | Not supported |
31+
| - | .NET 3.1, .NET 5 | Not supported |
4032
| 1.1.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) | :heavy_check_mark: |
41-
| 1.2.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) | :heavy_check_mark: |
42-
| 1.3.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) & [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) | :heavy_check_mark: |
43-
| 1.4.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) & [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) & [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) | :heavy_check_mark: |
44-
| 1.5.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) & [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) & [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) & [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) & [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) | :heavy_check_mark: |
33+
| 1.2.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) | :heavy_check_mark: |
34+
| 1.3.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) | :heavy_check_mark: |
35+
| 1.4.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0), [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) | :heavy_check_mark: |
36+
| 1.5.x | [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0), [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0), [.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0), [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) | :heavy_check_mark: |
4537

4638
- Supported .NET 10.0, .NET 9.0, .NET 8.0, .NET 7.0, .NET 6.0 versions for these web platforms:
4739
- Blazor WebAssembly
4840
- Blazor Server
4941
- Blazor Server Hybrid with MVC
5042
- MAUI Blazor Hybrid
5143

52-
Note: if you have problem with MAUI project dependencies:
53-
- `dotnet workload update` + rebuilt the project. If that doesn't help, try the step below about override package
54-
- override package, for example: `<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" VersionOverride="7.0.1" />`
44+
> [!NOTE]
45+
> If you have problem with MAUI project dependencies:
46+
> - `dotnet workload update` + rebuilt the project. If that doesn't help, try the step below about override package
47+
> - override package, for example: `<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" VersionOverride="7.0.1" />`
5548
5649
## Key features and aspects of the Cropper.Blazor package include
5750

src/Cropper.Blazor/Client/Pages/Index.razor

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,12 @@
5757
</MudButton>
5858
</MudItem>
5959
<p align="center">
60-
<a style="text-decoration:none" rel="noopener" href="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/ci.yml" target="_blank">
61-
<img loading="lazy" src="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/ci.yml/badge.svg?event=push" alt="Build and run test" />
60+
<a style="text-decoration:none" rel="noopener" href="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml" target="_blank">
61+
<img loading="lazy" src="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml/badge.svg?event=push" alt="Deploy to NuGet">
6262
</a>
6363
<a style="text-decoration:none" rel="noopener" href="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml" target="_blank">
6464
<img loading="lazy" src="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/cd.yml/badge.svg?event=push" alt="Deploy to GitHub Pages">
6565
</a>
66-
<a style="text-decoration:none" rel="noopener" href="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml" target="_blank">
67-
<img loading="lazy" src="https://github.com/CropperBlazor/Cropper.Blazor/actions/workflows/release.yml/badge.svg?event=push" alt="Deploy to NuGet">
68-
</a>
6966
<a style="text-decoration:none" rel="noopener" href="https://codecov.io/github/CropperBlazor/Cropper.Blazor" target="_blank">
7067
<img loading="lazy" src="https://codecov.io/github/CropperBlazor/Cropper.Blazor/branch/dev/graph/badge.svg?token=39M66DO85T" alt="Code coverage" />
7168
</a>
@@ -76,7 +73,10 @@
7673
<img loading="lazy" src="https://img.shields.io/github/last-commit/CropperBlazor/Cropper.Blazor?color=009DEA" alt="Last commit" />
7774
</a>
7875
<a style="text-decoration:none" rel="noopener" href="https://www.nuget.org/packages/Cropper.Blazor" target="_blank">
79-
<img loading="lazy" src="https://img.shields.io/nuget/dt/Cropper.Blazor?logo=nuget&label=nuget%20downloads&color=ff5c9b" alt="Nuget version and downloads" />
76+
<img loading="lazy" src="https://img.shields.io/nuget/dt/Cropper.Blazor?logo=nuget&label=nuget%20downloads&color=ff5c9b" alt="Nuget downloads" />
77+
</a>
78+
<a style="text-decoration:none" rel="noopener" href="https://www.nuget.org/packages/Cropper.Blazor" target="_blank">
79+
<img loading="lazy" src="https://img.shields.io/nuget/v/Cropper.Blazor?logo=nuget&label=nuget%20version&color=009DEA" alt="Nuget version" />
8080
</a>
8181
</p>
8282

0 commit comments

Comments
 (0)