Merge pull request #18 from Kyash/readme

Created draft readme

Author: konifar

README.md

@@ -0,0 +1,118 @@
+# ValidatableTextInputLayout
+
+[![Build Status](https://circleci.com/gh/Kyash/validatable-textinput-layout.svg?style=shield)](https://circleci.com/gh/Kyash/validatable-textinput-layout/tree/master)
+[![JitPack](https://jitpack.io/v/Kyash/validatable-textinput-layout.svg)](https://jitpack.io/#Kyash/validatable-textinput-layout)
+
+ValidatableTextInputLayout is the view which extended TextInputLayout to validate the input text easily for .
+
+## Download
+
+Project build.gradle
+
+```groovy
+allprojects {
+    repositories {
+        ...
+        maven { url "https://jitpack.io" }
+    }
+}
+```
+
+App build.gradle
+
+```groovy
+dependencies {
+    ...
+    compile 'com.kyash.vtl:validatable-textinput-layout:LATEST_VERSION'
+}
+```
+
+`LATEST_VERSION` is  [![JitPack](https://jitpack.io/v/Kyash/validatable-textinput-layout.svg)](https://jitpack.io/#Kyash/validatable-textinput-layout)
+
+## Basic usage
+You can use as same as `TextInputLayout` in layout xml.
+
+### Layout
+`trigger` attribute defines the timing of the text field validation. 
+
+```xml
+<co.kyash.vtl.ValidatableTextInputLayout
+  id="@id/first_name"
+  android:layout_width="match_parent"
+  android:layout_height="wrap_content"
+  app:trigger="text_changed">
+
+  <EditText
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content"
+    android:hint="@string/first_name"
+    android:inputType="textPersonName" />
+
+</co.kyash.vtl.ValidatableTextInputLayout>
+```
+
+### Kotlin
+Register Validator class to `ValidatableTextInputLayout`
+For example, `RequiredValidator` shows error when the field is empty.
+
+```kotlin
+private fun initValidator() {
+  binding.firstName.register(RequiredValidator(getString(R.string.validation_error_required)))
+}
+```
+
+That's it. It works as below.
+
+<img src="art/required_validator.gif" width="300">
+
+## Triggers
+There are 2 types of the validation trigger attributes.
+
+Attribute | Description
+:--: | :--
+text_changed | Validate immediately when the text is changed.
+focus_changed | Validate when the focus is changed
+
+## Validators
+This library provides some common validators
+ 
+Validator | Description
+:--: | :--
+RequiredValidator | Required validation
+EmailValidator | General Email address validation
+NumberOnlyValidator | Only numbers are permitted
+AsciiOnlyValidator | Only Ascii characters are permitted
+HiraganaOnlyValidator | Only Japanese Hiragana characters are permitted
+KatakanaOnlyValidator | Only Japanese Katakana characters are permitted
+
+
+
+## Custom validator
+You can create the custom validator by using `VtlValidator`.
+Since `VtlValidator` uses RxJava2, it can handle async logic like API as well!
+
+```
+
+```
+
+## Contributing
+We are always welcome your contribution!
+If you find a bug or want to add new feature, please raise issue.
+
+## License
+
+```
+Copyright 2018 Kyash
+
+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.
+```

art/email_validator.gif

@@ -128,15 +128,9 @@
 
                 </android.support.v7.widget.CardView>
 
-                <View
-                    android:layout_width="match_parent"
-                    android:layout_height="1dp"
-                    android:layout_marginBottom="@dimen/space_16dp"
-                    android:layout_marginTop="@dimen/space_16dp"
-                    android:background="@color/grey500" />
-
                 <TextView
                     style="@style/Title"
+                    android:layout_marginTop="@dimen/space_32dp"
                     android:text="@string/trigger_focus_change" />
 
                 <android.support.v7.widget.CardView