Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
emersoncloud committed Sep 7, 2018
1 parent cd5e7d4 commit a0017ae
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
Binary file added .repo/BlurKit-Brand-Half.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
![BlurKit Header](.repo/blurkit-android-header.png)
![BlurKit Header](.repo/BlurKit-Brand-Half.png)

## What Is BlurKit?
BlurKit is an extraordinarily easy to use and performant utility to render real time blur effects in Android.


BlurKit is an extraordinarily easy to use utility to get live blurring just like on iOS. Built by [Dylan McIntyre](https://github.com/dwillmc).

![BlurKit Demo](.repo/demo.gif)

Expand Down Expand Up @@ -70,7 +73,7 @@ Other attributes you can configure are the blur radius and the downscale factor.
blurkit:blk_fps="60" />
```

### Other
### Creating BlurKit Outside Of A Layout
You can use the `BlurKit` class which has a few useful blurring utilities. Before using this class outside of a `BlurLayout`, you need to initialize `BlurKit`.

```java
Expand Down Expand Up @@ -111,13 +114,13 @@ If you use Proguard, add the following to your proguard-rules.pro:
}
```

## To Do (incoming!)
## Upcoming Features
- [ ] `SurfaceView` support
- [ ] Support for use outside of an `Activity` (dialogs, etc.)
- [ ] Enhance retrieval of background content to only include views drawn behind the `BlurLayout`.

## Credits
Dylan McIntyre
Built by [Dylan McIntyre](https://github.com/dwillmc).

## License
BlurKit-Android is [MIT licensed](https://github.com/wonderkiln/blurkit-android/blob/master/LICENSE).

0 comments on commit a0017ae

Please sign in to comment.