Skip to content

Commit 162de0e

Browse files
authored
Create README.md
1 parent e4082b1 commit 162de0e

File tree

1 file changed

+97
-0
lines changed

1 file changed

+97
-0
lines changed

README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# CheckBoxTextViews
2+
<p>
3+
<a href="https://jitpack.io/#onemandan/CheckBoxTextViews" rel="nofollow"><img alt="API" src="https://img.shields.io/badge/API-15%2B-brightgreen.svg" style="max-width:100%;"></a>
4+
<a href="https://jitpack.io/#onemandan/CheckBoxTextViews" rel="nofollow"><img alt="Release" src="https://jitpack.io/v/onemandan/CheckBoxTextViews.svg" style="max-width:100%;"></a>
5+
<a href="https://raw.githubusercontent.com/onemandan/CheckBoxTextViews/master/LICENSE" rel="nofollow"><img alt="GitHub license" src="https://img.shields.io/badge/license-MIT-blue.svg" style="max-width:100%;"></a>
6+
</p>
7+
8+
9+
Transforms an array of strings into selectable items inside a FlexBox
10+
11+
<img src="https://raw.githubusercontent.com/onemandan/CheckBoxTextViews/master/Sample.jpg" height="430px"/>
12+
13+
## Installation
14+
To get CheckBoxTextViews into your project, add the repository to your build.gradle.
15+
16+
17+
#### Gradle
18+
1. Add the JitPack repository to your projects build.gradle:
19+
```gradle
20+
allprojects {
21+
repositories {
22+
...
23+
maven { url 'https://jitpack.io' }
24+
}
25+
}
26+
```
27+
28+
2. Add the dependency to your modules build.gradle :
29+
```gradle
30+
dependencies {
31+
implementation 'com.github.onemandan:CheckBoxTextViews:0.0.4'
32+
}
33+
```
34+
35+
#### Maven
36+
1. Add the JitPack repository to your build file:
37+
```xml
38+
<repositories>
39+
<repository>
40+
<id>jitpack.io</id>
41+
<url>https://jitpack.io</url>
42+
</repository>
43+
</repositories>
44+
```
45+
46+
2. Add the dependency:
47+
```xml
48+
<dependency>
49+
<groupId>com.github.onemandan</groupId>
50+
<artifactId>CheckBoxTextViews</artifactId>
51+
<version>0.0.4</version>
52+
</dependency>
53+
```
54+
55+
## Updates
56+
57+
#### 0.0.4
58+
- Release
59+
60+
## Usage
61+
``` xml
62+
<uk.co.onemandan.checkboxtextviews.CheckBoxTextViews
63+
android:layout_width="match_parent"
64+
android:layout_height="wrap_content"
65+
app:cbtv_items="@array/LoremIpsum"
66+
app:cbtv_selected="false"
67+
app:cbtv_default_background_color="@color/TintBlack10"
68+
app:cbtv_default_text_color="@color/colorTextPrimary"
69+
app:cbtv_selected_background_color="?colorAccent"
70+
app:cbtv_selected_text_color="@color/colorTextAccent"/>
71+
```
72+
73+
74+
## License
75+
```
76+
MIT License
77+
78+
Copyright (c) 2018 Daniel Hart
79+
80+
Permission is hereby granted, free of charge, to any person obtaining a copy
81+
of this software and associated documentation files (the "Software"), to deal
82+
in the Software without restriction, including without limitation the rights
83+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
84+
copies of the Software, and to permit persons to whom the Software is
85+
furnished to do so, subject to the following conditions:
86+
87+
The above copyright notice and this permission notice shall be included in all
88+
copies or substantial portions of the Software.
89+
90+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
91+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
92+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
93+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
94+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
95+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
96+
SOFTWARE.
97+
```

0 commit comments

Comments
 (0)