Skip to content

Commit 8a90185

Browse files
claudeclaude
committed
feat: add section markers to all package readme files
Add HTML comment markers to standardized sections across all 9 package readme files, enabling the readme sync tool to manage common content while preserving package-specific documentation. Changes: - Added markers to 9 readme files (8 packages + 1 plugin) - Marked 9 standardized sections per package: - nonstop-header: NonStop branding and logo - badges: Build status and license badges - getting-started: Installation instructions - import-package: Import statements - contributing: Contribution guidelines - connect: Social media links - star-footer: GitHub star CTA - license: MIT license information - founded-by: Founder attribution Updated packages: - connectivity_wrapper - dzod - timer_button - ns_intl_phone_input - html_rich_text - morse_tap - ns_utils - ns_firebase_utils - contact_permission (plugin) All package-specific content (features, usage examples, screenshots, etc.) preserved outside markers and remains unmanaged. The readme files are now ready for synchronization via melos sync:readme
1 parent 52b0211 commit 8a90185

9 files changed

Lines changed: 371 additions & 198 deletions

File tree

‎packages/connectivity_wrapper/README.md‎

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- BEGIN:nonstop-header -->
12
<p align="center">
23
<a href="https://nonstopio.com">
34
<img src="https://github.com/nonstopio.png" alt="Nonstop Logo" height="128" />
@@ -9,11 +10,14 @@
910
<a href="https://nonstopio.com">Website</a>
1011
</p>
1112
</p>
13+
<!-- END:nonstop-header -->
1214

1315
# connectivity_wrapper
1416

17+
<!-- BEGIN:badges -->
1518
[![Build Status](https://img.shields.io/pub/v/connectivity_wrapper.svg)](https://github.com/nonstopio/flutter_forge/tree/main/packages/connectivity_wrapper)
1619
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
20+
<!-- END:badges -->
1721

1822
This plugin allows Flutter apps provide feedback on your app when it's not connected to it, or when there's no connection.
1923

@@ -28,13 +32,31 @@ This plugin allows Flutter apps provide feedback on your app when it's not conne
2832
- Android Gradle Plugin >=8.3.0
2933
- Gradle wrapper >=8.4
3034

31-
## Usage
35+
<!-- BEGIN:getting-started -->
36+
## Getting Started
37+
38+
1. Open your project's `pubspec.yaml` file.
39+
2. Add the `connectivity_wrapper` package to your dependencies, replacing `[version]` with the latest version:
40+
```yaml
41+
dependencies:
42+
flutter:
43+
sdk: flutter
44+
connectivity_wrapper: ^[version]
45+
```
46+
3. Run `flutter pub get` to fetch the package.
47+
<!-- END:getting-started -->
48+
49+
<!-- BEGIN:import-package -->
50+
## Import the Package
3251

3352
```dart
3453
import 'package:connectivity_wrapper/connectivity_wrapper.dart';
3554
```
55+
<!-- END:import-package -->
56+
57+
## Usage
3658

37-
Check if device is connected to internet or not
59+
Check if device is connected to internet or not
3860

3961
```dart
4062
...
@@ -191,7 +213,7 @@ body: ConnectivityWidgetWrapper(
191213
<img src="https://cdn-images-1.medium.com/max/600/1*OeVKSyfV2X9VhupXRdwb2g.png" alt="Image 3" style="width: 280px; object-fit: cover; aspect-ratio: 9/16;">
192214

193215
## Custom Alignment and Disable User Interaction
194-
216+
195217

196218
```dart
197219
...
@@ -290,6 +312,9 @@ class NetworkAwareWidgetScreen extends StatelessWidget {
290312
whether you can reliably make a network connection. Always guard your app code
291313
against timeouts and errors that might come from the network layer.
292314

315+
---
316+
317+
<!-- BEGIN:contributing -->
293318
## Contributing
294319

295320
We welcome contributions in various forms:
@@ -301,6 +326,7 @@ We welcome contributions in various forms:
301326
- Sending Pull Requests is greatly appreciated!
302327

303328
A big thank you to all our contributors! 🙌
329+
<!-- END:contributing -->
304330

305331
<br></br>
306332
<div align="center">
@@ -311,34 +337,38 @@ A big thank you to all our contributors! 🙌
311337

312338
---
313339

340+
<!-- BEGIN:connect -->
314341
## 🔗 Connect with NonStop
315342

316-
<div align="center">
317-
318-
**Stay connected and get the latest updates!**
319-
320-
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/nonstop-io)
321-
[![X.com](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/NonStopio)
322-
[![Instagram](https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/nonstopio_technologies/)
323-
[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@NonStopioTechnology)
324-
[![Email](https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:contact@nonstopio.com)
325-
326-
</div>
343+
<p align="center">
344+
<a href="https://www.linkedin.com/company/nonstopio"><img src="https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white" alt="LinkedIn"></a>
345+
<a href="https://x.com/nonstopio"><img src="https://img.shields.io/badge/-X.com-000000?style=flat-square&logo=X&logoColor=white" alt="X.com"></a>
346+
<a href="https://www.instagram.com/nonstopio/"><img src="https://img.shields.io/badge/-Instagram-E4405F?style=flat-square&logo=Instagram&logoColor=white" alt="Instagram"></a>
347+
<a href="https://www.youtube.com/@nonstopio"><img src="https://img.shields.io/badge/-YouTube-FF0000?style=flat-square&logo=YouTube&logoColor=white" alt="YouTube"></a>
348+
<a href="mailto:hello@nonstopio.com"><img src="https://img.shields.io/badge/-Email-D14836?style=flat-square&logo=Gmail&logoColor=white" alt="Email"></a>
349+
</p>
350+
<!-- END:connect -->
327351

328352
---
329353

354+
<!-- BEGIN:star-footer -->
330355
<div align="center">
331356

332357
> ⭐ Star us on [GitHub](https://github.com/nonstopio/flutter_forge) if this helped you!
333358

334359
</div>
360+
<!-- END:star-footer -->
335361

362+
<!-- BEGIN:license -->
336363
## 📜 License
337364

338365
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
366+
<!-- END:license -->
339367

368+
<!-- BEGIN:founded-by -->
340369
<div align="center">
341370

342371
> 🎉 [Founded by Ajay Kumar](https://github.com/ProjectAJ14) 🎉**
343372

344373
</div>
374+
<!-- END:founded-by -->

‎packages/dzod/README.md‎

Lines changed: 51 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- BEGIN:nonstop-header -->
12
<p align="center">
23
<a href="https://nonstopio.com">
34
<img src="https://github.com/nonstopio.png" alt="Nonstop Logo" height="128" />
@@ -9,13 +10,15 @@
910
<a href="https://nonstopio.com">Website</a>
1011
</p>
1112
</p>
13+
<!-- END:nonstop-header -->
1214

1315
<h1 align="center">🔐 Dzod</h1>
1416

1517
<p align="center">
1618
<strong>⚡ Enterprise-grade Dart schema validation library</strong>
1719
</p>
1820

21+
<!-- BEGIN:badges -->
1922
<p align="center">
2023
<a href="https://pub.dev/packages/dzod"><img src="https://img.shields.io/pub/v/dzod.svg?label=dzod&logo=dart&color=blue&style=for-the-badge" alt="pub package"></a>
2124
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-purple.svg?style=for-the-badge" alt="License"></a>
@@ -26,6 +29,7 @@
2629
<img src="https://img.shields.io/badge/Test_Coverage-99.3%25-darkgreen.svg?style=for-the-badge" alt="Test Coverage">
2730
<img src="https://img.shields.io/badge/Tests-1588+-blue.svg?style=for-the-badge" alt="Tests">
2831
</p>
32+
<!-- END:badges -->
2933

3034
---
3135

@@ -41,12 +45,29 @@ Dzod is an **enterprise-grade** Dart schema validation library heavily inspired
4145

4246
---
4347

44-
## 🚀 Quick Start
48+
<!-- BEGIN:getting-started -->
49+
## Getting Started
50+
51+
1. Open your project's `pubspec.yaml` file.
52+
2. Add the `dzod` package to your dependencies, replacing `[version]` with the latest version:
53+
```yaml
54+
dependencies:
55+
flutter:
56+
sdk: flutter
57+
dzod: ^[version]
58+
```
59+
3. Run `flutter pub get` to fetch the package.
60+
<!-- END:getting-started -->
4561

46-
```bash
47-
# Add to your pubspec.yaml
48-
dart pub add dzod
62+
<!-- BEGIN:import-package -->
63+
## Import the Package
64+
65+
```dart
66+
import 'package:dzod/dzod.dart';
4967
```
68+
<!-- END:import-package -->
69+
70+
## 🚀 Quick Start
5071

5172
### Example 1: Basic User Schema Validation
5273

@@ -1048,34 +1069,50 @@ for (final entry in userSchema.shape.entries) {
10481069

10491070
---
10501071

1051-
## 🔗 Connect with NonStop
1072+
<!-- BEGIN:contributing -->
1073+
## Contributing
10521074

1053-
<div align="center">
1075+
We welcome contributions in various forms:
10541076

1055-
**Stay connected and get the latest updates!**
1077+
- Proposing new features or enhancements.
1078+
- Reporting and fixing bugs.
1079+
- Engaging in discussions to help make decisions.
1080+
- Improving documentation, as it is essential.
1081+
- Sending Pull Requests is greatly appreciated!
10561082

1057-
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/nonstop-io)
1058-
[![X.com](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/NonStopio)
1059-
[![Instagram](https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/nonstopio_technologies/)
1060-
[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@NonStopioTechnology)
1061-
[![Email](https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:contact@nonstopio.com)
1083+
A big thank you to all our contributors! 🙌
1084+
<!-- END:contributing -->
10621085

1063-
</div>
1086+
<!-- BEGIN:connect -->
1087+
## 🔗 Connect with NonStop
10641088

1065-
---
1089+
<p align="center">
1090+
<a href="https://www.linkedin.com/company/nonstopio"><img src="https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white" alt="LinkedIn"></a>
1091+
<a href="https://x.com/nonstopio"><img src="https://img.shields.io/badge/-X.com-000000?style=flat-square&logo=X&logoColor=white" alt="X.com"></a>
1092+
<a href="https://www.instagram.com/nonstopio/"><img src="https://img.shields.io/badge/-Instagram-E4405F?style=flat-square&logo=Instagram&logoColor=white" alt="Instagram"></a>
1093+
<a href="https://www.youtube.com/@nonstopio"><img src="https://img.shields.io/badge/-YouTube-FF0000?style=flat-square&logo=YouTube&logoColor=white" alt="YouTube"></a>
1094+
<a href="mailto:hello@nonstopio.com"><img src="https://img.shields.io/badge/-Email-D14836?style=flat-square&logo=Gmail&logoColor=white" alt="Email"></a>
1095+
</p>
1096+
<!-- END:connect -->
10661097

1098+
<!-- BEGIN:star-footer -->
10671099
<div align="center">
10681100

10691101
> ⭐ Star us on [GitHub](https://github.com/nonstopio/flutter_forge) if this helped you!
10701102

10711103
</div>
1104+
<!-- END:star-footer -->
10721105

1106+
<!-- BEGIN:license -->
10731107
## 📜 License
10741108

10751109
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
1110+
<!-- END:license -->
10761111

1112+
<!-- BEGIN:founded-by -->
10771113
<div align="center">
10781114

10791115
> 🎉 [Founded by Ajay Kumar](https://github.com/ProjectAJ14) 🎉**
10801116

10811117
</div>
1118+
<!-- END:founded-by -->

‎packages/html_rich_text/README.md‎

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- BEGIN:nonstop-header -->
12
<p align="center">
23
<a href="https://nonstopio.com">
34
<img src="https://github.com/nonstopio.png" alt="Nonstop Logo" height="128" />
@@ -9,11 +10,14 @@
910
<a href="https://nonstopio.com">Website</a>
1011
</p>
1112
</p>
13+
<!-- END:nonstop-header -->
1214

1315
# HTML Rich Text
1416

17+
<!-- BEGIN:badges -->
1518
[![Build Status](https://img.shields.io/pub/v/html_rich_text.svg)](https://github.com/nonstopio/flutter_forge/tree/main/packages/html_rich_text)
1619
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
20+
<!-- END:badges -->
1721

1822
A lightweight Flutter package for rendering HTML-styled text without heavy dependencies. Perfect for simple HTML text rendering with minimal overhead.
1923

@@ -32,22 +36,27 @@ HTML Rich Text is an ultra-lightweight solution for parsing and displaying HTML-
3236
- **O(n) Performance**: Single-pass parsing algorithm for optimal performance
3337
- **Tree-Shaking Friendly**: Unused code is automatically removed during compilation
3438

39+
<!-- BEGIN:getting-started -->
3540
## Getting Started
3641

37-
1. Add `html_rich_text` to your `pubspec.yaml`:
42+
1. Open your project's `pubspec.yaml` file.
43+
2. Add the `html_rich_text` package to your dependencies, replacing `[version]` with the latest version:
3844
```yaml
3945
dependencies:
4046
flutter:
4147
sdk: flutter
42-
html_rich_text: ^1.0.0
48+
html_rich_text: ^[version]
4349
```
44-
2. Run `flutter pub get` to fetch the package.
50+
3. Run `flutter pub get` to fetch the package.
51+
<!-- END:getting-started -->
4552

53+
<!-- BEGIN:import-package -->
4654
## Import the Package
4755

4856
```dart
4957
import 'package:html_rich_text/html_rich_text.dart';
5058
```
59+
<!-- END:import-package -->
5160

5261
## Usage
5362

@@ -199,45 +208,50 @@ This package is designed for simple HTML text styling. It does not support:
199208

200209
For complex HTML rendering needs, consider using full-featured packages like `flutter_html`.
201210

211+
<!-- BEGIN:contributing -->
202212
## Contributing
203213

204214
We welcome contributions in various forms:
205215

206-
- Proposing new features or enhancements
207-
- Reporting and fixing bugs
208-
- Improving documentation
209-
- Sending Pull Requests
216+
- Proposing new features or enhancements.
217+
- Reporting and fixing bugs.
218+
- Engaging in discussions to help make decisions.
219+
- Improving documentation, as it is essential.
220+
- Sending Pull Requests is greatly appreciated!
210221

211-
---
222+
A big thank you to all our contributors! 🙌
223+
<!-- END:contributing -->
212224

225+
<!-- BEGIN:connect -->
213226
## 🔗 Connect with NonStop
214227

215-
<div align="center">
216-
217-
**Stay connected and get the latest updates!**
218-
219-
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/nonstop-io)
220-
[![X.com](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/NonStopio)
221-
[![Instagram](https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/nonstopio_technologies/)
222-
[![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@NonStopioTechnology)
223-
[![Email](https://img.shields.io/badge/Email-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:contact@nonstopio.com)
224-
225-
</div>
226-
227-
---
228+
<p align="center">
229+
<a href="https://www.linkedin.com/company/nonstopio"><img src="https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white" alt="LinkedIn"></a>
230+
<a href="https://x.com/nonstopio"><img src="https://img.shields.io/badge/-X.com-000000?style=flat-square&logo=X&logoColor=white" alt="X.com"></a>
231+
<a href="https://www.instagram.com/nonstopio/"><img src="https://img.shields.io/badge/-Instagram-E4405F?style=flat-square&logo=Instagram&logoColor=white" alt="Instagram"></a>
232+
<a href="https://www.youtube.com/@nonstopio"><img src="https://img.shields.io/badge/-YouTube-FF0000?style=flat-square&logo=YouTube&logoColor=white" alt="YouTube"></a>
233+
<a href="mailto:hello@nonstopio.com"><img src="https://img.shields.io/badge/-Email-D14836?style=flat-square&logo=Gmail&logoColor=white" alt="Email"></a>
234+
</p>
235+
<!-- END:connect -->
228236

237+
<!-- BEGIN:star-footer -->
229238
<div align="center">
230239

231240
> ⭐ Star us on [GitHub](https://github.com/nonstopio/flutter_forge) if this helped you!
232241

233242
</div>
243+
<!-- END:star-footer -->
234244

245+
<!-- BEGIN:license -->
235246
## 📜 License
236247

237248
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
249+
<!-- END:license -->
238250

251+
<!-- BEGIN:founded-by -->
239252
<div align="center">
240253

241254
> 🎉 [Founded by Ajay Kumar](https://github.com/ProjectAJ14) 🎉**
242255

243256
</div>
257+
<!-- END:founded-by -->

0 commit comments

Comments
 (0)