Skip to content

Commit 3e5b910

Browse files
docs: Refactor readme
1 parent 52d8849 commit 3e5b910

File tree

1 file changed

+65
-11
lines changed

1 file changed

+65
-11
lines changed

README.md

Lines changed: 65 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,42 @@
11
# Form Builder Image Picker
22

3+
Images picker field for FlutterFormBuilder. Get images from gallery or camera.
4+
35
[![Pub Version](https://img.shields.io/pub/v/form_builder_image_picker?logo=flutter&style=for-the-badge)](https://pub.dev/packages/form_builder_image_picker)
46
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/flutter-form-builder-ecosystem/form_builder_image_picker/Base?logo=github&style=for-the-badge)](https://github.com/flutter-form-builder-ecosystem/form_builder_image_picker/actions/workflows/base.yaml)
57
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/flutter-form-builder-ecosystem/form_builder_image_picker?logo=codefactor&style=for-the-badge)](https://www.codefactor.io/repository/github/flutter-form-builder-ecosystem/form_builder_image_picker)
68
[![Codecov](https://img.shields.io/codecov/c/github/flutter-form-builder-ecosystem/form_builder_image_picker?logo=codecov&style=for-the-badge)](https://codecov.io/gh/flutter-form-builder-ecosystem/form_builder_image_picker/)
9+
[![Discord](https://img.shields.io/discord/985922433578053673?logo=discord&style=for-the-badge)](https://discord.com/invite/25KNPMJQf2)
710

8-
Images picker field for FlutterFormBuilder. Get images from gallery or camera.
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+
- Pick image from gallery or camera
30+
- Show images in form
31+
- Support several images types: `Uint8List`, `XFile`, `String` (url) or `ImageProvider`
932

10-
# Setup
33+
## Use
1134

12-
Since this package makes use of [image_picker package](https://pub.dev/packages/image_picker), for platform specific setup, follow the instructions [here](https://github.com/flutter/plugins/tree/main/packages/image_picker/image_picker#installation)
35+
### Setup
1336

14-
## Usage
37+
Since this package makes use of [image_picker](https://pub.dev/packages/image_picker) package, for platform specific setup, follow the instructions [here](https://github.com/flutter/plugins/tree/main/packages/image_picker/image_picker#installation)
38+
39+
### Basuc use
1540

1641
```dart
1742
FormBuilder(
@@ -23,18 +48,47 @@ FormBuilder(
2348
decoration: const InputDecoration(labelText: 'Pick Photos'),
2449
maxImages: 1,
2550
),
26-
const SizedBox(height: 15),
27-
RaisedButton(onPressed: (){
28-
if(_formKey.currentState.saveAndValidate()){
29-
print(_formKey.currentState.value);
30-
}
31-
})
3251
],
3352
),
3453
),
3554
```
3655

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

3993
<a href="https://github.com/flutter-form-builder-ecosystem/form_builder_image_picker/graphs/contributors">
4094
<img src="https://contrib.rocks/image?repo=flutter-form-builder-ecosystem/form_builder_image_picker" />

0 commit comments

Comments
 (0)