Skip to content

Commit f034bcf

Browse files
authored
Update readme.md
1 parent 72444a9 commit f034bcf

File tree

1 file changed

+37
-36
lines changed

1 file changed

+37
-36
lines changed

readme.md

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,6 @@
22

33
**TextCraft** is a powerful and flexible custom Android view that extends `MaterialTextView`, designed to provide advanced text styling capabilities. With support for gradient colors, strike-through, underline, drawable integration, vertical text alignment, and ripple effects, TextCraft allows developers to style heading, subheading, and paragraph sections individually. It also includes Kotlin extension methods for enhanced functionality and supports localized strike-through and gradient text effects.
44

5-
## Features
6-
7-
- **Customizable Headings, Subheadings, and Paragraphs**
8-
- Set text, color, size, underline, strike-through, text style (bold, italic), and gravity for each section.
9-
10-
- **Gradient Support**
11-
- Apply gradient effects separately to the heading, subheading, and paragraph sections.
12-
- Customize start, center, and end colors of the gradient.
13-
- Control gradient orientation (horizontal, vertical, diagonal) for each section.
14-
15-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen1.png?raw=true)
16-
17-
- **Strike-through and Underline**
18-
- Apply strike-through and underline effects to specific substrings in the heading, subheading, and paragraph sections.
19-
20-
- **Drawable Support**
21-
- Add drawable icons to the start, center, or end of any section (heading, subheading, paragraph).
22-
23-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen2.png?raw=true)
24-
25-
- **Ripple Effect**
26-
- Enable ripple effect on text click, with customizable ripple color.
27-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/screen_gif.gif?raw=true)
28-
29-
30-
- **Stroke, Background, and Corner Radius**
31-
- Set stroke width and color around the text view.
32-
- Apply gradient backgrounds (linear, radial, sweep) and control the corner radius for the view's background.
33-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen3.png?raw=true)
34-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen4.png?raw=true)
35-
36-
- **Vertical Text and Direction**
37-
- Enable vertical text alignment for all sections and control its direction (up or down).
38-
39-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen5.png?raw=true)
40-
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen6.png?raw=true)
415
## Gradle Integration
426

437
### Step A: Add Maven Repository
@@ -145,6 +109,43 @@ materialTextView.addImage("Insert Here", R.drawable.ic_image, imgWidth = 40, img
145109
| `headingDrawableStart`, `subheadingDrawableStart`, `paragraphDrawableStart` | reference | Set drawable at the start of each section. |
146110
| `headingDrawableEnd`, `subheadingDrawableEnd`, `paragraphDrawableEnd` | reference | Set drawable at the end of each section. |
147111

112+
## Features
113+
114+
- **Customizable Headings, Subheadings, and Paragraphs**
115+
- Set text, color, size, underline, strike-through, text style (bold, italic), and gravity for each section.
116+
117+
- **Gradient Support**
118+
- Apply gradient effects separately to the heading, subheading, and paragraph sections.
119+
- Customize start, center, and end colors of the gradient.
120+
- Control gradient orientation (horizontal, vertical, diagonal) for each section.
121+
122+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen1.png?raw=true)
123+
124+
- **Strike-through and Underline**
125+
- Apply strike-through and underline effects to specific substrings in the heading, subheading, and paragraph sections.
126+
127+
- **Drawable Support**
128+
- Add drawable icons to the start, center, or end of any section (heading, subheading, paragraph).
129+
130+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen2.png?raw=true)
131+
132+
- **Ripple Effect**
133+
- Enable ripple effect on text click, with customizable ripple color.
134+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/screen_gif.gif?raw=true)
135+
136+
137+
- **Stroke, Background, and Corner Radius**
138+
- Set stroke width and color around the text view.
139+
- Apply gradient backgrounds (linear, radial, sweep) and control the corner radius for the view's background.
140+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen3.png?raw=true)
141+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen4.png?raw=true)
142+
143+
- **Vertical Text and Direction**
144+
- Enable vertical text alignment for all sections and control its direction (up or down).
145+
146+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen5.png?raw=true)
147+
![screenshot](https://github.com/hypersoftdev/TextCraft/blob/master/Screens/Screen6.png?raw=true)
148+
148149

149150
# Acknowledgements
150151

0 commit comments

Comments
 (0)