Skip to content

Commit

Permalink
update README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
Vladimir Borutsky authored Jun 23, 2020
1 parent 0a4b4b6 commit 5a81c50
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,31 @@ Elevation determines automatically by checking component parent views. Currently
Add it in your root build.gradle at the end of repositories:
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
repositories {
maven { url 'https://jitpack.io' }
}
}
```
Add the dependency :
```groovy
dependencies {
implementation 'com.github.Borutsky:neumorphism-android:1.0.0-alpha01'
}
implementation 'com.github.Borutsky:neumorphism-android:1.0.0-alpha01'
}
```

## Usage

Parent of Neumorphic element should always contain **android:clipChildren="false"**. It is required to avoid shadow to be clipped.
Background of the window and all the Neumorphic components should have the same color. By respecting these advices you will be able to build a Neumorphic app with unified view of all elements.

### NeumorphicFrameLayout Example:

```xml
<com.borutsky.neumorphism.NeumorphicFrameLayout
android:layout_width="300dp"
android:layout_height="300dp"
app:backgroundColor="#55B9F3"
app:cornerRadius="40dp"
app:background_color="#55B9F3"
app:corner_radius="40dp"
app:shape="rectangle"
app:state="flat"/>
```
Expand Down

0 comments on commit 5a81c50

Please sign in to comment.