From bb80c10fbda7e7febc54df5a7c027f2c1e82e028 Mon Sep 17 00:00:00 2001
From: Haytham <46851726+haytham-c01@users.noreply.github.com>
Date: Sat, 25 Apr 2020 19:14:27 +0300
Subject: [PATCH] Create README.md
---
README.md | 130 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 130 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f729956
--- /dev/null
+++ b/README.md
@@ -0,0 +1,130 @@
+# Rectangular Step view
+A highly customizeable step view, where you can change
+
+1. inital step
+2. current step
+3. height & width
+4. border color & size
+5. active color
+
+# Example
+
+
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+```
+# Installation
+1. Add maven to project-level gradle file
+```
+allprojects {
+ repositories {
+ google()
+ jcenter()
+
+ maven { url 'https://jitpack.io' }
+ }
+}
+```
+2. Add the dependency in your module-level gradle file
+```
+dependencies {
+...
+implementation 'com.github.haytham-c01:CurveView:LATEST_RELEASE'
+}
+```
+# Attributes
+
+| Name | Description | Type | Default Value |
+| -------------------------- |--------------------------------| :------------------------------: | :-----------: |
+| initialStep | the default active step | integer [0 - (stepsCount-1)] | 0 |
+| stepsCount | number of steps in the view | integer [at least 2] | 3 |
+| borderColor | color of view border | color | Black |
+| activeColor | color of the active step | color | Green |
+| stepViewStrokeWidth | width of the shape border | dimension [at least 0] | 1dp |
+| heightToWidthRatio | the percentage of view height
in respect to its width | float [0.01f - 0.2f] | 0.08f |
+
+# Code Guide
+#### 1- Increment by one step
+```
+stepView.incrementStep()
+```
+#### 2- Decrement by one step
+```
+stepView.decrementStep()
+```
+#### 3- Goto step
+```
+val stepNumber= 4
+stepView.gotoStep(stepNumber)
+```
+#### 4- Listen to step changes
+```
+stepView.onStepChangedListener = {
+ previousStep, currentStep ->
+ // do something
+ }
+```
+
+# License
+```
+Copyright 2013 Square, Inc.
+
+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.
+```