Skip to content

Commit 3c23237

Browse files
authored
Update README.md
1 parent 15c0cbf commit 3c23237

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1-
# BlurHashKit
1+
Basic port of the [Swift implementation for BlurHash](https://github.com/woltapp/blurhash/tree/master/Swift/BlurHashKit).
22

3-
This Swift Package is a basic port of the [Swift implementation for BlurHash](https://github.com/woltapp/blurhash/tree/master/Swift/BlurHashKit). This was simply created to finally stop copying the contents over to new projects and create a separation of concern for the BlurHash implementation.
3+
## BlurHashView
4+
5+
`BlurHashView` has been provided as an easy way to use a BlurHash in SwiftUI.
6+
7+
```swift
8+
// Example
9+
BlurHashView(
10+
blurHash: "LGF5?xYk^6#M@-5c,1J5@[or[Q6.",
11+
size: CGSize(width: 4, height: 3),
12+
pixels: 512,
13+
punch: 0.8
14+
)
15+
```
16+
17+
## Development
18+
- [ ] macOS support

0 commit comments

Comments
 (0)