Skip to content

Commit

Permalink
creating readMe docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MuhammedRefaat authored Nov 5, 2019
1 parent 6835dde commit ef81ec5
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,53 @@ Customizable Color Palette Library

You can use this library to add customizable color palette to your Android application, which comes with an attractive sets of colors to be used for the palette, in addition to a nice UI for displaying the color palette.

How to include the Library in your application:
## How to include the Library in your application:

Step 1. Add the JitPack repository to your build file
**Step 1. Add the JitPack repository to your build file (project level)**

Add it in your root build.gradle at the end of repositories:

***for Gradle:***

allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}

Step 2. Add the dependency

for Gradle:
***for Maven:***

<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>


**Step 2. Add the dependency**

***for Gradle:***

dependencies {
implementation 'com.github.MuhammedRefaat:ColorPalette:1.0'
implementation 'com.github.MuhammedRefaat:ColorPalette:Tag'
}

for Maven:
***for Maven:***

<dependency>
<groupId>com.github.MuhammedRefaat</groupId>
<artifactId>ColorPalette</artifactId>
<version>1.0</version>
<version>Tag</version>
</dependency>


## How to use the Library:

<com.imagine.colorpalette.ColorPalette
android:id="@+id/color_palette4"
android:layout_width="match_parent"
android:layout_height="wrap_content"
colorPalette:palette="blackAndWhite" />

0 comments on commit ef81ec5

Please sign in to comment.