Skip to content

Commit b92a997

Browse files
docs: Refactor readme
1 parent bda83b2 commit b92a997

File tree

1 file changed

+66
-3
lines changed

1 file changed

+66
-3
lines changed

README.md

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,38 @@
44
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/flutter-form-builder-ecosystem/form_builder_phone_field/Base?logo=github&style=for-the-badge)](https://github.com/flutter-form-builder-ecosystem/form_builder_phone_field/actions/workflows/base.yaml)
55
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/flutter-form-builder-ecosystem/form_builder_phone_field?logo=codefactor&style=for-the-badge)](https://www.codefactor.io/repository/github/flutter-form-builder-ecosystem/form_builder_phone_field)
66
[![Codecov](https://img.shields.io/codecov/c/github/flutter-form-builder-ecosystem/form_builder_phone_field?logo=codecov&style=for-the-badge)](https://codecov.io/gh/flutter-form-builder-ecosystem/form_builder_phone_field/)
7+
[![Discord](https://img.shields.io/discord/985922433578053673?logo=discord&style=for-the-badge)](https://discord.com/invite/25KNPMJQf2)
78

8-
International phone number field for [FlutterFormBuilder](https://pub.dev/packages/flutter_form_builder) package
9+
International phone number field for [flutter_form_builder](https://pub.dev/packages/flutter_form_builder) package.
910

10-
# Usage
11+
___
12+
13+
- [Features](#features)
14+
- [Use](#use)
15+
- [Setup](#setup)
16+
- [Basic use](#basic-use)
17+
- [Especific uses](#especific-uses)
18+
- [Support](#support)
19+
- [Contribute](#contribute)
20+
- [Questions and answers](#questions-and-answers)
21+
- [Donations](#donations)
22+
- [Roadmap](#roadmap)
23+
- [Ecosystem](#ecosystem)
24+
- [Thanks to](#thanks-to)
25+
- [Contributors](#contributors)
26+
27+
## Features
28+
29+
- Country selector
30+
- Automatic parsing international number
31+
32+
## Use
33+
34+
### Setup
35+
36+
No especific setup required: only install the dependency and use :)
37+
38+
### Basic use
1139

1240
```dart
1341
FormBuilderPhoneField(
@@ -22,8 +50,43 @@ FormBuilderPhoneField(
2250
]),
2351
),
2452
```
53+
See [pud.dev example tab](https://pub.dev/packages/form_builder_phone_field/example) or [github code](example/lib/main.dart) for more details
54+
55+
## Support
56+
57+
### Contribute
58+
59+
You have some ways to contribute to this packages
60+
61+
- Beginner: Reporting bugs or request new features
62+
- Intermediate: Implement new features (from issues or not) and created pull requests
63+
- Advanced: Join to [organization](#ecosystem) like a member and help coding, manage issues, dicuss new features and other things
64+
65+
See [contribution file](https://github.com/flutter-form-builder-ecosystem/.github/blob/main/CONTRIBUTING.md) for more details
66+
67+
### Questions and answers
68+
69+
You can join to [our Discord server](https://discord.gg/25KNPMJQf2) or search answers in [StackOverflow](https://stackoverflow.com/questions/tagged/flutter-form-builder)
70+
71+
### Donations
72+
73+
Buy a coffe to [Danvick Miller](https://twitter.com/danvickmiller), creator of this awesome package
74+
75+
[![Buy me a coffee](https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-1.svg)](https://www.buymeacoffee.com/danvick)
76+
77+
## Roadmap
78+
79+
- [Add complete web support](https://github.com/flutter-form-builder-ecosystem/form_builder_phone_field/issues/11)
80+
- [Add visual examples](https://github.com/flutter-form-builder-ecosystem/form_builder_phone_field/issues/12) (images, gifs, videos, sample application)
81+
- [Solve open issues](https://github.com/flutter-form-builder-ecosystem/form_builder_phone_field/issues), [prioritizing bugs](https://github.com/flutter-form-builder-ecosystem/form_builder_phone_field/labels/bug)
82+
83+
## Ecosystem
84+
85+
Take a look to [our awesome ecosystem](https://github.com/flutter-form-builder-ecosystem) and all packages in there
86+
87+
## Thanks to
2588

26-
## Credits
89+
### Contributors
2790

2891
**Contributors**
2992

0 commit comments

Comments
 (0)