Skip to content

Commit b759d81

Browse files
committed
update readme & yaml file
1 parent 78f78e5 commit b759d81

File tree

2 files changed

+55
-2
lines changed

2 files changed

+55
-2
lines changed

README.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# GST Validator Flutter Package
22

33
![Pub Version](https://img.shields.io/pub/v/gstvalidator)
4-
![GitHub License](https://img.shields.io/github/license/vignesh235/gstvalidator)
54

65
A Flutter package for validating Goods and Services Tax (GST) numbers. The package provides a customizable `GSTvalidator` widget that can be easily integrated into Flutter forms for GST number validation.
76

@@ -12,3 +11,50 @@ To use this package, add `gstvalidator` as a dependency in your `pubspec.yaml` f
1211
```yaml
1312
dependencies:
1413
gstvalidator: ^0.0.1
14+
```
15+
16+
17+
## Features
18+
19+
### 1. GST Number Validation
20+
21+
Easily validate GST numbers using the customizable widget within your Flutter application.
22+
23+
### 2. Customization Options
24+
25+
Tailor the widget to your needs with the following customization features:
26+
27+
- **Maximum Length:** Specify the maximum length for GST numbers.
28+
- **Keyboard Type:** Define the keyboard type to enhance the user experience.
29+
30+
### 3. Seamless Integration
31+
32+
Integrate the GST number validation widget effortlessly into your Flutter forms. It works seamlessly, providing a user-friendly experience without compromising on validation accuracy.
33+
34+
## Usage
35+
36+
To use the GST Number Validation Widget in your Flutter project, follow these steps:
37+
38+
1. Import the necessary package.
39+
```dart
40+
import 'package:flutter_gst_validator/flutter_gst_validator.dart';
41+
```
42+
2. Use the Widget
43+
```dart
44+
GSTvalidator(
45+
labelText: 'GST',
46+
suffixIcon: Icons.abc,
47+
controller: _controller,
48+
autovalidateMode: AutovalidateMode.onUserInteraction,
49+
),
50+
```
51+
52+
53+
54+
55+
56+
57+
58+
59+
60+

pubspec.yaml

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
name: gstvalidator
22
description: "A Flutter package for validating GST (Goods and Services Tax) numbers."
3-
version: 0.0.1
3+
version: 0.0.5
44
homepage:
55

66
environment:
77
sdk: '>=3.2.3 <4.0.0'
88
flutter: ">=1.17.0"
99

10+
repository: https://github.com/vignesh235/gstvalidator
11+
12+
platforms:
13+
ios:
14+
android:
15+
web:
16+
1017
dependencies:
1118
flutter:
1219
sdk: flutter

0 commit comments

Comments
 (0)