Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Serchinastico committed Mar 4, 2015
1 parent 9fcbada commit d87e2fd
Showing 1 changed file with 52 additions and 1 deletion.
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
# CoolSwitcher
# CoolSwitch

CoolSwitch is a custom view for Android with an awesome reveal animation with support for Android versions >2.3.+

![alt tag](https://raw.github.com/Serchinastico/CoolSwitcher/master/demo.gif)

# Usage

* 1. Include the switch view in your layout as usual, including the views shown when the switch is disabled and enabled. If any of the views are undefined then the animation won't play.
```xml
<com.serchinastico.coolswitch.CoolSwitch
android:id="@+id/cool_switch_foo"
android:layout_height="35dp"
android:layout_width="60dp"
coolswitch:disabledView="@id/disabled_view_foo"
coolswitch:enabledView="@id/enabled_view_foo"/>
```
* 2. Wrap your animated views in either a TargetFrameLayout or a TargetLinearLayout.
```xml
<com.serchinastico.coolswitch.TargetFrameLayout
android:layout_width="match_parent"
android:layout_height="match_parent">

<LinearLayout
android:id="@+id/disabled_view_foo"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="#FF0000"/>

<LinearLayout
android:id="@+id/enabled_view_foo"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="#00FF00"/>

</com.serchinastico.coolswitch.TargetFrameLayout>
```

# License
```
Copyright 2014 Pedro Vicente Gómez Sánchez
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

0 comments on commit d87e2fd

Please sign in to comment.