diff --git a/README.md b/README.md index 937759d..ea0d284 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,84 @@ Simple color picker library for Android Screenshot -## Installation -TODO: Describe the installation process -## Usage -TODO: Write usage instructions +Download +-------- +Download latest version with Gradle: +```groovy +repositories { + maven { url 'https://jitpack.io' } +} + +dependencies { + compile 'com.github.naz013:ColorSlider:1.0.1' +} +``` + +Usage +----- +Default (Material colors picker): +```xml + +``` +Gradient (Params: cs_from_color, cs_to_color, cs_steps): +via XML: +```xml + +``` +in code: +```java +colorSlider.setGradient(@ColorInt int fromColor, @ColorInt int toColor, int steps) +``` + + +Array of color resources (Params: cs_colors): +via XML: +```xml + +``` +in code: +```java +colorSlider.setColors(@ColorInt int[] colors) +``` + + +String array of hex colors (Params: cs_hex_colors): +via XML: +```xml + +``` +in code: +```java +colorSlider.setHexColors(String[] hexColors) +``` + +Also you can set listener for color picker: +```java +colorSlider.setListener(new ColorSlider.OnColorSelectedListener() { + @Override + public void onColorChanged(int position, int color) { + updateView(color); + } + }) +``` + License -------