Merge pull request #32 from flutter-form-builder-ecosystem/refactor-readme

Refactor readme

Author: deandreamatias

.github/workflows/base.yaml

@@ -49,13 +49,13 @@ jobs:
           flutter build ios --debug --no-codesign
           flutter build web
 
-      - name: Upload coverage to Codecov
-        if: ${{ matrix.channel == 'stable' }}
-        uses: codecov/codecov-action@v3
-        with:
-          files: coverage/lcov.info
-          flags: unittests
-          name: flutter_form_builder
+      # - name: Upload coverage to Codecov
+      #   if: ${{ matrix.channel == 'stable' }}
+      #   uses: codecov/codecov-action@v3
+      #   with:
+      #     files: coverage/lcov.info
+      #     flags: unittests
+      #     name: form_builder_image_picker
 
   deployment:
     if: ${{ github.ref_type == 'tag' }}
@@ -79,3 +79,13 @@ jobs:
         sh ./tool/pub_login.sh
     - name: Publish package
       run: dart pub publish -v -f
+    - name: Build changelog
+      id: github_release
+      uses: mikepenz/release-changelog-builder-action@v3
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Create release
+      uses: softprops/action-gh-release@v0.1.14
+      with:
+        body: ${{steps.github_release.outputs.changelog}}
+

README.md

@@ -1,17 +1,42 @@
 # Form Builder Image Picker
 
+Images picker field for FlutterFormBuilder. Get images from gallery or camera.
+
 [![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)
 [![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)
 [![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)
 [![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/)
+[![Discord](https://img.shields.io/discord/985922433578053673?logo=discord&style=for-the-badge)](https://discord.com/invite/25KNPMJQf2)
 
-Images picker field for FlutterFormBuilder. Get images from gallery or camera.
+___
+
+- [Features](#features)
+- [Use](#use)
+    - [Setup](#setup)
+    - [Basic use](#basic-use)
+    - [Especific uses](#especific-uses)
+- [Support](#support)
+    - [Contribute](#contribute)
+    - [Questions and answers](#questions-and-answers)
+    - [Donations](#donations)
+- [Roadmap](#roadmap)
+- [Ecosystem](#ecosystem)
+- [Thanks to](#thanks-to)
+    - [Contributors](#contributors)
+
+## Features
+
+- Pick image from gallery or camera
+- Show images in form
+- Support several images types: `Uint8List`, `XFile`, `String` (url) or `ImageProvider`
 
-# Setup
+## Use
 
-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)
+### Setup
 
-## Usage
+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)
+
+### Basuc use
 
 ```dart
 FormBuilder(
@@ -23,18 +48,47 @@ FormBuilder(
         decoration: const InputDecoration(labelText: 'Pick Photos'),
         maxImages: 1,
       ),
-      const SizedBox(height: 15),
-      RaisedButton(onPressed: (){
-        if(_formKey.currentState.saveAndValidate()){
-          print(_formKey.currentState.value);
-        }
-      })
     ],
   ),
 ),
 ```
 
-## Credits
+See [pud.dev example tab](https://pub.dev/packages/form_builder_image_picker/example) or [github code](example/lib/main.dart) for more details
+
+## Support
+
+### Contribute
+
+You have some ways to contribute to this packages
+
+ - Beginner: Reporting bugs or request new features
+ - Intermediate: Implement new features (from issues or not) and created pull requests
+ - Advanced: Join to [organization](#ecosystem) like a member and help coding, manage issues, dicuss new features and other things
+
+ See [contribution file](https://github.com/flutter-form-builder-ecosystem/.github/blob/main/CONTRIBUTING.md) for more details
+
+### Questions and answers
+
+You can join to [our Discord server](https://discord.gg/25KNPMJQf2) or search answers in [StackOverflow](https://stackoverflow.com/questions/tagged/flutter-form-builder)
+
+### Donations
+
+Buy a coffe to [Danvick Miller](https://twitter.com/danvickmiller), creator of this awesome package
+
+[![Buy me a coffee](https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-1.svg)](https://www.buymeacoffee.com/danvick)
+
+
+## Roadmap
+
+- [Add visual examples](https://github.com/flutter-form-builder-ecosystem/form_builder_image_picker/issues/31) (images, gifs, videos, sample application)
+- [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)
+
+## Ecosystem
+
+Take a look to [our awesome ecosystem](https://github.com/flutter-form-builder-ecosystem) and all packages in there
+
+## Thanks to
+### Contributors
 
 <a href="https://github.com/flutter-form-builder-ecosystem/form_builder_image_picker/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=flutter-form-builder-ecosystem/form_builder_image_picker" />