Skip to content

Updated README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kevin-Kip wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ Create a beautiful blurry background with simple code and less work.
Use this layout to place views above it while keeping the background awesome. Use your image and colors to come up
with a cool layout that matches yorur needs
## Screenshot
![alt text](https://github.com/carloscj6/BlurryLayout/blob/master/Screenshots/device-2018-10-11-002239.png "Blurry Layout")
<img src="/Screenshots/device-2018-10-11-002239.png" width="250px">

## Setup
First include the library in your project with:

`implementation 'com.revosleap.layout:blurrylayout:1.0.0'`

In your `layout.xml` file, set the parent layout as:

```
```xml
<com.revosleap.blurrylayout.BlurryLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
Expand All @@ -30,21 +31,21 @@ In your activity class you need to pass the image to be used as background;
Set image and blur radius as


` blurLayout.blurBackground(bitmap,10);`
```java blurLayout.blurBackground(bitmap,10);```

**Note:** blur radius takes `int`. It determines the amount of the blur effect.
**Note:** blur radius takes ```java int```. It determines the amount of the blur effect.

### Blur color
Set as `blurLayout.blurColor(Color.WHITE);`.
Set as ```java blurLayout.blurColor(Color.WHITE);```.
This is the color of the background blur.

Can be determined by the color of views above it. Example,
textviews with light color will need a darker blur color and vice versa.
**Note:** blur color takes `int`.

### Blur opacity
set as `blurLayout.blurOpacity(0.3f);`
set as ```java blurLayout.blurOpacity(0.3f);```

Determines the opacity of the blurry backgroud. Higher values mean the blur color is more visible and vice versa.
It takes `float`
It takes ``` java float```