Skip to content

Commit a11ac3e

Browse files
Update Library banner and README.md file
1 parent 7fdc8b3 commit a11ac3e

7 files changed

Lines changed: 66 additions & 42 deletions

README.md

Lines changed: 66 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
1+
![alt text](/images/library_banner.png)
2+
13
# SSComposeShowCaseView
4+
25
[![Compose Version](https://img.shields.io/badge/Jetpack%20Compose-1.2.0--beta03-brightgreen)](https://developer.android.com/jetpack/compose)
36
[![Kotlin Version](https://img.shields.io/badge/Kotlin-v1.6.21-blue.svg)](https://kotlinlang.org)
47
[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)
58
[![Platform](https://img.shields.io/badge/Platform-Android-green.svg?style=flat)](https://www.android.com/)
69

710
## Introduction
8-
In this repository, provided demonstration for showcaseview, which is a way to display features of our app to users.
11+
12+
SSComposeShowCaseView is a customizable show case view library which allows to showcase/highlight
13+
the particular features of the application with an engaging overlay. It also provides automatic
14+
showcase view feature with customised delay and opacity attributes.
915

1016
## Features
17+
1118
* Simple rounded showcase view
1219
* Simple rectangle showcase view
1320
* Animated rounded showcase view
@@ -19,33 +26,34 @@ In this repository, provided demonstration for showcaseview, which is a way to d
1926

2027
| Simple Rounded | Animated Rounded |
2128
|--|--|
22-
| <img src="/gif/Simple_Rounded_Showcase_View.gif" height="500px"/> | <img src="/gif/Animated_Rounded_Showcase_View.gif" height="500px"/> |
29+
| <img src="/images/Simple_Rounded_Showcase_View.gif" height="500px"/> | <img src="/images/Animated_Rounded_Showcase_View.gif" height="500px"/> |
2330

2431
| Simple Rectangle | Animated Rectangle |
2532
|--|--|
26-
| <img src="/gif/Simple_Rectangle_Showcase_View.gif" height="500px"/> | <img src="/gif/Animated_Rectangle_Showcase_View.gif" height="500px"/> |
33+
| <img src="/images/Simple_Rectangle_Showcase_View.gif" height="500px"/> | <img src="/images/Animated_Rectangle_Showcase_View.gif" height="500px"/> |
2734

2835
### Gradle Dependency
36+
2937
* Add it in your root build.gradle at the end of repositories:
3038

31-
- For Gradle version 5.x.x or less
32-
```
33-
allprojects {
34-
repositories {
35-
...
36-
maven { url 'https://jitpack.io' }
37-
}
38-
}
39-
```
40-
- For Gradle version 6.x.x and above, in settings.gradle file inside `pluginManagement` block
41-
```
42-
pluginManagement {
43-
repositories {
44-
...
45-
maven { url 'https://jitpack.io' }
46-
}
47-
}
48-
```
39+
- For Gradle version 5.x.x or less
40+
```
41+
allprojects {
42+
repositories {
43+
...
44+
maven { url 'https://jitpack.io' }
45+
}
46+
}
47+
```
48+
- For Gradle version 6.x.x and above, in settings.gradle file inside `pluginManagement` block
49+
```
50+
pluginManagement {
51+
repositories {
52+
...
53+
maven { url 'https://jitpack.io' }
54+
}
55+
}
56+
```
4957
5058
* Add the dependency in your app's build.gradle file
5159
@@ -56,6 +64,7 @@ In this repository, provided demonstration for showcaseview, which is a way to d
5664
```
5765
5866
## 🤔 How to use it
67+
5968
* Composable function which is used to start showcase view
6069
```kotlin
6170
fun ShowCaseTarget(
@@ -91,7 +100,8 @@ In this repository, provided demonstration for showcaseview, which is a way to d
91100
}
92101
```
93102

94-
* On which ever component you need to showcase, take coordinates of that component using Modifier.onGloballyPositioned and use ShowcaseProperty like shown below
103+
* On which ever component you need to showcase, take coordinates of that component using
104+
Modifier.onGloballyPositioned and use ShowcaseProperty like shown below
95105
```kotlin
96106
Image(
97107
imageVector = Icons.Default.MoreVert,
@@ -112,6 +122,7 @@ In this repository, provided demonstration for showcaseview, which is a way to d
112122

113123
### All Attributes
114124
------------------------
125+
115126
| Attribute | Description | Default |
116127
| --- | --- | --- |
117128
| `index` | Set index to show showcase one by one | None |
@@ -127,35 +138,58 @@ In this repository, provided demonstration for showcaseview, which is a way to d
127138
| `key` | To manage if showcase already shown or not | None |
128139

129140
## Inspired by
141+
130142
- [canopas/Intro-showcase-view](https://github.com/canopas/Intro-showcase-view)
131143

132144
## Our Libraries in JetPackCompose
133-
- [SSJetPackComposeProgressButton](https://github.com/SimformSolutionsPvtLtd/SSJetPackComposeProgressButton) : SSJetPackComposeProgressButton is an elegant button with a different loading animations which makes your app attractive.
134-
- [SSJetpackComposeSwipeableView](https://github.com/SimformSolutionsPvtLtd/SSJetpackComposeSwipeableView) : SSJetpackComposeSwipeableView is a small library which provides support for the swipeable views. You can use this in your lazyColumns or can add a simple view which contains swipe to edit/delete functionality.
135-
- [SSComposeOTPPinView](https://github.com/SimformSolutionsPvtLtd/SSComposeOTPPinView) : A custom OTP view to enter a code usually used in authentication. It includes different types of OTPViews which is easy to use and configure your own view and character of OTP using all the attributes.
145+
146+
- [SSJetPackComposeProgressButton](https://github.com/SimformSolutionsPvtLtd/SSJetPackComposeProgressButton) :
147+
SSJetPackComposeProgressButton is an elegant button with a different loading animations which
148+
makes your app attractive.
149+
- [SSJetpackComposeSwipeableView](https://github.com/SimformSolutionsPvtLtd/SSJetpackComposeSwipeableView) :
150+
SSJetpackComposeSwipeableView is a small library which provides support for the swipeable views.
151+
You can use this in your lazyColumns or can add a simple view which contains swipe to edit/delete
152+
functionality.
153+
- [SSComposeOTPPinView](https://github.com/SimformSolutionsPvtLtd/SSComposeOTPPinView) : A custom
154+
OTP view to enter a code usually used in authentication. It includes different types of OTPViews
155+
which is easy to use and configure your own view and character of OTP using all the attributes.
136156

137157
## Official Documentations
158+
138159
- [Jetpack Compose](https://developer.android.com/jetpack/compose)
139160
- [Jetpack Compose Pathways](https://developer.android.com/courses/pathways/compose)
140161
- [Jetpack Compose Samples](https://github.com/android/compose-samples)
141162

142163
## Find this library useful? ❤️
143-
Support it by joining __[stargazers](https://github.com/SimformSolutionsPvtLtd/SSComposeShowCaseView/stargazers)__ for this repository.⭐
164+
165+
Support it by
166+
joining __[stargazers](https://github.com/SimformSolutionsPvtLtd/SSComposeShowCaseView/stargazers)__
167+
for this repository.⭐
144168

145169
## How to Contribute🤝
146-
Whether you're helping us fix bugs, improve the docs, or a feature request, we'd love to have you! 💪
147-
Check out our __[Contributing Guide](https://github.com/SimformSolutionsPvtLtd/SSComposeShowCaseView/blob/develop/CONTRIBUTING.md)__ for ideas on contributing.
170+
171+
Whether you're helping us fix bugs, improve the docs, or a feature request, we'd love to have you!
172+
💪 Check out
173+
our __[Contributing Guide](https://github.com/SimformSolutionsPvtLtd/SSComposeShowCaseView/blob/develop/CONTRIBUTING.md)__
174+
for ideas on contributing.
148175

149176
## 🐛 Bugs and Feedback
150-
For bugs, feature requests, and discussion please use [GitHub Issues](https://github.com/SimformSolutionsPvtLtd/SSComposeShowCaseView/issues).
151177

152-
## Our Showcase View Library in Flutter
153-
- Check out our Flutter library [Flutter_ShowCaseView](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview)
178+
For bugs, feature requests, and discussion please
179+
use [GitHub Issues](https://github.com/SimformSolutionsPvtLtd/SSComposeShowCaseView/issues).
180+
181+
## Our Flutter Showcase View Library
182+
183+
- Check out our Flutter
184+
library [Flutter ShowCaseView](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview)
154185

155186
## Awesome Mobile Libraries
156-
- Check out our other available [awesome mobile libraries](https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries)
187+
188+
- Check out our other
189+
available [awesome mobile libraries](https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries)
157190

158191
## License
192+
159193
```
160194
MIT License
161195
File renamed without changes.

images/library_banner.png

448 KB
Loading

local.properties

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)