Skip to content

Commit e243f42

Browse files
doc: 📝 Documentation Update to latest version
1 parent be84f21 commit e243f42

File tree

3 files changed

+296
-300
lines changed

3 files changed

+296
-300
lines changed

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,54 @@
11
![Showcase View - Simform LLC.](https://raw.githubusercontent.com/SimformSolutionsPvtLtd/flutter_showcaseview/master/preview/banner.png)
22

3-
43
# ShowCaseView
54

65
[![Build](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/actions/workflows/flutter.yaml/badge.svg?branch=master)](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/actions) [![showcaseview](https://img.shields.io/pub/v/showcaseview?label=showcaseview)](https://pub.dev/packages/showcaseview)
6+
[![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-FC60A8?logo=awesome-lists)](https://github.com/Solido/awesome-flutter#ui-helpers)
77

8-
A Flutter package that allows you to showcase/highlight your widgets step by step, providing interactive tutorials for your application's UI.
8+
A Flutter package that allows you to showcase/highlight your widgets step by step, providing
9+
interactive tutorials for your application's UI.
910

1011
_Check out other amazing open-source [Flutter libraries](https://simform-flutter-packages.web.app) and [Mobile libraries](https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries) developed by Simform Solutions!_
1112

1213
## Preview
14+
_**For live web demo, visit [ShowcaseView Web Example](https://simformsolutionspvtltd.github.io/flutter_showcaseview/)**_
1315

14-
![The example app running in Android](https://raw.githubusercontent.com/SimformSolutionsPvtLtd/flutter_showcaseview/master/preview/showcaseview.gif)
16+
![The example app running on mobile](https://raw.githubusercontent.com/SimformSolutionsPvtLtd/flutter_showcaseview/master/preview/showcaseview.gif)
1517

1618
## Features
1719

18-
- Guide users through your app by highlighting specific widgets step by step
19-
- Customize tooltips with titles, descriptions, and styling
20-
- Handles scrolling the widget into view for showcasing
21-
- Support for custom tooltip widgets
22-
- Animation and transition effects for tooltip
23-
- Options to showcase multiple widgets at the same time
20+
- Guide users through your app by highlighting specific widgets step by step.
21+
- Customize tooltips with titles, descriptions, and styling.
22+
- Handles scrolling the widget into view for showcasing.
23+
- Support for custom tooltip widgets.
24+
- Animation and transition effects for tooltip.
25+
- Options to showcase multiple widgets at the same time.
26+
27+
## Performance Gains on v5.x.x
28+
29+
Version 5.0.0+ delivers exceptional performance improvements that make ShowcaseView faster and
30+
more efficient than ever:
31+
32+
![performance_boost](https://raw.githubusercontent.com/SimformSolutionsPvtLtd/flutter_showcaseview/master/preview/performance_boost.png)
33+
34+
> *Performance metrics based on internal benchmarking tests performed on a mid-tier android device.*
35+
36+
### 🚀 **Memory Reduction**
37+
- **Optimized memory usage**: Reduced from **1.8 MB to 0.6 MB**
38+
- Significantly reduced memory footprint for better app performance
39+
40+
### **Faster Refresh**
41+
- **Smoother animations**: Average FPS increased from **58 to 88 FPS**
42+
- Better performance on lower-end devices and complex UI layouts
43+
44+
### 🎯 **Quicker Rendering**
45+
- **Lightning-fast startup**: Initial render time reduced from **68ms to 24ms**
46+
- Dramatically improved time-to-interactive for showcases
2447

2548
## Documentation
2649

27-
Visit our [documentation](https://simform-flutter-packages.web.app/showCaseView) site for all implementation details, usage instructions, code examples, and advanced features.
50+
Visit our [documentation](https://simform-flutter-packages.web.app/showCaseView) site for all
51+
implementation details, usage instructions, code examples, and advanced features.
2852

2953
## Installation
3054

0 commit comments

Comments
 (0)