Skip to content

Commit d3cdbcd

Browse files
docs: update example app README for clarity and structure
1 parent 553cd86 commit d3cdbcd

2 files changed

Lines changed: 19 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Additional form inputs fields with Cupertino style for [flutter_form_builder](ht
44

55
[![Pub Version](https://img.shields.io/pub/v/form_builder_cupertino_fields?logo=flutter&style=for-the-badge)](https://pub.dev/packages/form_builder_cupertino_fields)
66
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/flutter-form-builder-ecosystem/form_builder_cupertino_fields/base.yaml?branch=main&logo=github&style=for-the-badge)](https://github.com/flutter-form-builder-ecosystem/form_builder_cupertino_fields/actions/workflows/base.yaml)
7-
[![Codecov](https://img.shields.io/codecov/c/github/flutter-form-builder-ecosystem/form_builder_cupertino_fields?logo=codecov&style=for-the-badge)](https://codecov.io/gh/flutter-form-builder-ecosystem/form_builder_cupertino_fields/)
7+
[![Codecov](https://img.shields.io/codecov/c/github/flutter-form-builder-ecosystem/form_builder_cupertino_fields?logo=codecov&style=for-the-badge)](https://app.codecov.io/gh/flutter-form-builder-ecosystem/form_builder_cupertino_fields)
88
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/flutter-form-builder-ecosystem/form_builder_cupertino_fields?logo=codefactor&style=for-the-badge)](https://www.codefactor.io/repository/github/flutter-form-builder-ecosystem/form_builder_cupertino_fields)
99

1010
---

example/README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
1-
# example
1+
# Example app
22

3-
A new Flutter project.
3+
This Flutter app demonstrates the widgets provided by the
4+
`form_builder_cupertino_fields` package.
45

5-
## Getting Started
6+
## Run locally
67

7-
This project is a starting point for a Flutter application.
8+
1. Install Flutter 3.32.0+ and Dart 3.8.0+.
9+
2. From this folder, get dependencies:
810

9-
A few resources to get you started if this is your first Flutter project:
11+
```bash
12+
flutter pub get
13+
```
1014

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
15+
3. Run on a device or emulator:
1316

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
17+
```bash
18+
flutter run
19+
```
20+
21+
## Notes
22+
23+
- The app is intended as a minimal showcase.
24+
- For package usage, see the repository root README.

0 commit comments

Comments
 (0)