Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
waacton committed Feb 9, 2022
1 parent 4d8f892 commit 2c03225
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ A `Unicolour` encapsulates a single colour and its representation across differe
- CIE XYZ
- CIE LAB

Unicolour uses sRGB as the default RGB model and D65 (2° observer) as the default illuminant of the XYZ colour space.
These can be overridden using the `Configuration` parameter.
Unicolour uses sRGB as the default RGB model and standard illuminant D65 (2° observer) as the default white point of the XYZ colour space.
These [can be overridden](#-advanced-configuration-) using the `Configuration` parameter.

This library was initially written for personal projects since existing libraries had complex APIs or missing features.
The goal of this library is to be intuitive and easy to use; performance is not a priority.
Expand All @@ -25,7 +25,7 @@ More functionality will be added over time.
Targets .NET Standard 2.0 for use in .NET 5.0+, .NET Core 2.0+ and .NET Framework 4.6.1+ applications.

## How to use 🎨
1. Install the package from [NuGet](https://www.nuget.org/packages/Wacton.Unicolour/)
1. Install the package from [NuGet](https://www.nuget.org/packages/Wacton.Unicolour/)
```
dotnet add package Wacton.Unicolour
```
Expand Down Expand Up @@ -60,9 +60,7 @@ var contrast = unicolour1.Contrast(unicolour2);
var difference = unicolour1.DeltaE76(unicolour2);
```

<details>
<summary><strong>Advanced configuration 💡</strong></summary>

## Advanced configuration 💡
A `Configuration` parameter can be used to change the RGB model (e.g. Adobe RGB, wide-gamut RGB)
and the white point of the XYZ colour space (e.g. D50 reference white used by ICC profiles).

Expand All @@ -82,8 +80,6 @@ var config = new Configuration(
var unicolour = Unicolour.FromRgb(config, 255, 20, 147);
```

</details>

---

[Wacton.Unicolour](https://gitlab.com/Wacton/Unicolour) is licensed under the [MIT License](https://choosealicense.com/licenses/mit/), copyright © 2022 William Acton.

0 comments on commit 2c03225

Please sign in to comment.