Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add section about sample project.
  • Loading branch information
Boris-Em authored Aug 26, 2020
1 parent ed0a265 commit 9b51501
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

- [Features](#features)
- [Installation](#installation)
- [Sample Project](#sample-project)
- [Contributing](#contributing)
- [License](#license)

Expand Down Expand Up @@ -134,15 +135,15 @@ Here is a short list of examples:
let hexValue = UIColor.green.hex
let color = UIColor(hex: "eb4034")
```
- Generating random colors.
- Generating random colors
```swift
let randomColor = UIColor.random()
```
- Calculating the relative luminance of a color
```swift
let relativeLuminance = UIColor.green.relativeLuminance
```
- Calculating complementary colors
- Generating complementary colors
```swift
let complementaryColor = UIColor.green.complementaryColor
```
Expand All @@ -165,7 +166,13 @@ Alternatively, you can also use XCode to add **ColorKit** to your existing proje

### Manually

**ColorKit** can also be added to your project manually. Download the **ColorKit** project from Github, them drag and drop the folder `ColorKit/ColorKit` into your XCode project.
**ColorKit** can also be added to your project manually. Download the **ColorKit** project from Github, then drag and drop the folder `ColorKit/ColorKit` into your XCode project.

</br>

## Sample Project

Use the iOS sample project included in this repository to find comprehensive examples of the different features of **ColorKit**.

</br>

Expand Down

0 comments on commit 9b51501

Please sign in to comment.