diff --git a/README.md b/README.md index 26971b2..fc32dd9 100644 --- a/README.md +++ b/README.md @@ -1 +1,134 @@ -# OmegaLayouts \ No newline at end of file +[![](https://jitpack.io/v/Omega-R/OmegaLayouts.svg)](https://jitpack.io/#Omega-R/OmegaLayouts) +[![GitHub license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT) + +# OmegaLayouts +Several different layout to make your life easier. + +# Installation +To get a Git project into your build: + +**Step 1.** Add the JitPack repository to your build file +``` +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } +} +``` +**Step 2.** Add the dependency +``` +dependencies { + implementation 'com.github.Omega-R:R:OmegaLayouts:0.0.1' +} +``` + +# Usage + +## Percents +Layouts which support percentage based dimensions and margins. You can specify dimension or a margin of child by using attributes with "Percent" suffix. + +Supported classes: +* com.omega_r.libs.layouts.percent.PercentLinearLayout +* com.omega_r.libs.layouts.percent.PercentRelativeLayout +* com.omega_r.libs.layouts.percent.PercentFrameLayout + +Follow this example: +``` + + + +``` + +## Shadow + +Shadow layouts draw shadow inside your layout. + +Supported classes: +* com.omega_r.libs.layouts.shadow.ShadowFrameLayout +* com.omega_r.libs.layouts.shadow.ShadowLinearLayout +* com.omega_r.libs.layouts.shadow.ShadowRelativeLayout + + +

+ +

+ +``` + +``` + +## AutoOrientationLinearLayout + +AutoOrientationLinearLayout it's subclass of LinearLayoutCompat that change orientation automatically if you don't have necessary width for all views on small screens. +Follow this example: + + + +``` + + + + + + + +``` + + +# License +``` +The MIT License + +Copyright 2017 Omega-R + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, +sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +```