Skip to content

Commit 5ecdc49

Browse files
mbkrispymbkrispy
committed
Update README.md
1 parent 6cab647 commit 5ecdc49

1 file changed

Lines changed: 43 additions & 45 deletions

File tree

‎README.md‎

Lines changed: 43 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,45 @@
1-
![Nuget](https://img.shields.io/nuget/v/IronDrawing?color=informational&label=latest) ![Installs](https://img.shields.io/nuget/dt/IronDrawing?color=informational&label=installs&logo=nuget) ![Passed](https://img.shields.io/badge/build-%20%E2%9C%93%20258%20tests%20passed%20(0%20failed)%20-107C10?logo=visualstudio) ![windows](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=windows) ![macOS](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=apple) ![linux](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=linux&logoColor=white) ![docker](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=docker&logoColor=white) ![aws](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=amazonaws) ![microsoftazure](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=microsoftazure)
1+
![Nuget](https://img.shields.io/nuget/v/IronSoftware.System.Drawing?color=informational&label=latest) ![Installs](https://img.shields.io/nuget/dt/IronSoftware.System.Drawing?color=informational&label=installs&logo=nuget)
2+
# IronSoftware.Drawing - Image, Color, Rectangle, and Font class for .NET Applications
23
​
3-
# IronDrawing - Image, Color, Rectangle, and Font class for .NET Applications
4+
**IronSoftware.Drawing** is an open-source library originally developed by Iron Software that helps C# Software Engineers to replace System.Drawing.Common in .NET projects.
45
​
5-
IronDrawing is a library developed and maintained by Iron Software that helps C# Software Engineers to replace System.Drawing.Common in .NET projects.
6-
​
7-
### IronDrawing Features and Capabilities:
8-
- AnyBitmap: A universally compatible Bitmap class. Implicit casting between `IronDrawing.AnyBitmap` and the following:
6+
### IronSoftware.Drawing Features and Capabilities:
7+
- **AnyBitmap**: A universally compatible Bitmap class. Implicit casting between `IronSoftware.Drawing.AnyBitmap` and the following supported:
98
- `System.Drawing.Bitmap`
109
- `System.Drawing.Image`
1110
- `SkiaSharp.SKBitmap`
1211
- `SkiaSharp.SKImage`
1312
- `SixLabors.ImageSharp`
1413
- `Microsoft.Maui.Graphics.Platform.PlatformImage`
15-
- Color: A universally compatible Color class. Implicit casting between `IronDrawing.Color` and the following:
14+
- **Color**: A universally compatible Color class. Implicit casting between `IronSoftware.Drawing.Color` and the following supported:
1615
- `System.Drawing.Color`
1716
- `SkiaSharp.SKColor`
1817
- `SixLabors.ImageSharp.Color`
1918
- `SixLabors.ImageSharp.PixelFormats`
20-
- CropRectangle: A universally compatible Rectangle class. Implicit casting between `IronDrawing.CropRectangle` and the following:
19+
- **CropRectangle**: A universally compatible Rectangle class. Implicit casting between `IronSoftware.Drawing.CropRectangle` and the following supported:
2120
- `System.Drawing.Rectangle`
2221
- `SkiaSharp.SKRect`
2322
- `SkiaSharp.SKRectI`
2423
- `SixLabors.ImageSharp.Rectangle`
25-
- Font: A universally compatible Font class. Implicit casting between `IronDrawing.Font` and the following:
24+
- **Font**: A universally compatible Font class. Implicit casting between `IronSoftware.Drawing.Font` and the following supported:
2625
- `System.Drawing.Font`
2726
- `SkiaSharp.SKFont`
2827
- `SixLabors.Fonts.Font`
2928
​
30-
### IronDrawing has cross platform support compatibility with:
29+
### IronSoftware.Drawing has cross platform support compatibility with:
3130
- .NET 7, .NET 6, .NET 5, .NET Core, Standard, and Framework
3231
- Windows, macOS, Linux, Docker, Azure, and AWS
3332
​
34-
## Using IronDrawing
33+
## Using IronSoftware.Drawing
3534
​
36-
Installing the IronDrawing NuGet package is quick and easy, please install the package like this:
35+
Installing the IronSoftware.Drawing NuGet package is quick and easy, please install the package like this:
3736
```
38-
PM> Install-Package IronDrawing
37+
PM> Install-Package IronSoftware.System.Drawing
3938
```
40-
Once installed, you can get started by adding `using IronDrawing` to the top of your C# code.
39+
Once installed, you can get started by adding `using IronSoftware.Drawing;` to the top of your C# code.
4140
### `AnyBitmap` Code Example
4241
```csharp
43-
using IronDrawing;
42+
using IronSoftware.Drawing;
4443
​
4544
// Create a new AnyBitmap object
4645
var bitmap = AnyBitmap.FromFile("FILE_PATH");
@@ -51,69 +50,68 @@ var bytes = bitmap.ExportBytes();
5150
var resultExport = new System.IO.MemoryStream();
5251
bimtap.ExportStream(resultExport, AnyBitmap.ImageFormat.Jpeg, 100);
5352
​
54-
// Casting between System.Drawing.Bitmap to IronDrawing.AnyBitmap
53+
// Casting between System.Drawing.Bitmap and IronSoftware.Drawing.AnyBitmap
5554
System.Drawing.Bitmap image = new System.Drawing.Bitmap("FILE_PATH");
56-
var anyBitmap = image;
55+
IronSoftware.Drawing.AnyBitmap anyBitmap = image;
5756
anyBitmap.SaveAs("result-from-casting.png");
5857
```
5958
### `Color` Code Example
6059
```csharp
61-
using IronDrawing;
60+
using IronSoftware.Drawing;
6261
​
6362
// Create a new Color object
6463
Color fromHex = new Color("#191919");
6564
Color fromRgb = new Color(255, 255, 0);
6665
Color fromEnum = Color.Crimson;
6766
​
68-
// Casting between System.Drawing.Color to IronDrawing.Color
67+
// Casting between System.Drawing.Color and IronSoftware.Drawing.Color
6968
System.Drawing.Color drawingColor = System.Drawing.Color.Red;
70-
IronDrawing.Color ironDrawingColor = drawingColor;
69+
IronSoftware.Drawing.Color ironColor = drawingColor;
7170
​
72-
ironDrawingColor.A;
73-
ironDrawingColor.R;
74-
ironDrawingColor.G;
75-
ironDrawingColor.B;
71+
ironColor.A;
72+
ironColor.R;
73+
ironColor.G;
74+
ironColor.B;
7675
​
7776
// Luminance is a value from 0 (black) to 100 (white) where 50 is the perceptual "middle grey"
78-
ironDrawingColor.GetLuminance();
77+
IronDrawingColor.GetLuminance();
7978
```
8079
### `CropRectangle` Code Example
8180
```csharp
82-
using IronDrawing;
81+
using IronSoftware.Drawing;
8382
​
8483
// Create a new CropRectangle object
8584
CropRectangle cropRectangle = new CropRectangle(5, 5, 50, 50);
8685
​
87-
// Casting between System.Drawing.Rectangle to IronDrawing.CropRectangle
86+
// Casting between System.Drawing.Rectangle and IronSoftware.Drawing.CropRectangle
8887
System.Drawing.Rectangle rectangle = new System.Drawing.Rectangle(10, 10, 150, 150);
89-
CropRectangle ironDrawingCropRectangle = rectangle;
88+
IronSoftware.Drawing.CropRectangle ironRectangle = rectangle;
9089
​
91-
ironDrawingCropRectangle.Width;
92-
ironDrawingCropRectangle.Height;
93-
ironDrawingCropRectangle.X;
94-
ironDrawingCropRectangle.Y;
90+
ironRectangle.X;
91+
ironRectangle.Y;
92+
ironRectangle.Width;
93+
ironRectangle.Height;
9594
```
9695
### `Font` Code Example
9796
```csharp
98-
using IronDrawing;
97+
using IronSoftware.Drawing;
9998
​
10099
// Create a new Font object
101100
Font font = new Font("Times New Roman", FontStyle.Italic | FontStyle.Bold, 30);
102101
​
103-
// Casting between System.Drawing.Font to IronDrawing.Font
102+
// Casting between System.Drawing.Font and IronSoftware.Drawing.Font
104103
System.Drawing.Font drawingFont = new System.Drawing.Font("Courier New", 30);
105-
IronDrawing.Font ironDrawingFont = drawingFont;
104+
IronSoftware.Drawing.Font ironFont = drawingFont;
106105
​
107-
ironDrawingFont.FamilyName;
108-
ironDrawingFont.Style;
109-
ironDrawingFont.Size;
110-
ironDrawingFont.Italic;
111-
ironDrawingFont.Bold;
106+
ironFont.FamilyName;
107+
ironFont.Style;
108+
ironFont.Size;
109+
ironFont.Italic;
110+
ironFont.Bold;
112111
```
113112
​
114113
## Support Available
115-
​
116-
For more information on Iron Software please visit: [https://ironsoftware.com/](https://ironsoftware.com/)
117-
​
118-
​
119-
For general support and technical inquiries, please email us at: developers@ironsoftware.com
114+
115+
For more information about Iron Software please visit our website: [https://ironsoftware.com/](https://ironsoftware.com/)
116+
117+
For general support and technical inquiries, please email us at: developers@ironsoftware.com

0 commit comments

Comments
 (0)