Skip to content

Commit fd95241

Browse files
authored
docs: improve formatting and readability in README.md (#113)
1 parent 1a08569 commit fd95241

1 file changed

Lines changed: 47 additions & 25 deletions

File tree

README.md

Lines changed: 47 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,20 @@
2222

2323
The internet connectivity checker that actually works! 🌐
2424

25-
Because sometimes `ConnectivityResult.wifi` means you're connected to a router that's as useful as a chocolate teapot! 🍫🫖
25+
Because sometimes `ConnectivityResult.wifi` means you're connected to a router
26+
that's as useful as a chocolate teapot! 🍫🫖
2627

27-
_Like trust issues, but for your network connection. We ping, therefore we know._
28+
_Like trust issues, but for your network connection. We ping, therefore we
29+
know._
2830

2931
[![pub package][package_svg]][package] [![GitHub][license_svg]](LICENSE)
3032

3133
<hr />
3234

33-
**✅ Check real internet connectivity, not just Wi-Fi connection**
34-
**🚀 Subsecond response times** _(even on mobile networks!)_
35-
**📡 Listen to connectivity changes in real-time**
36-
**⚙️ Fully customizable endpoints and success criteria**
35+
**✅ Check real internet connectivity, not just Wi-Fi connection**\
36+
**🚀 Subsecond response times** _(even on mobile networks!)_\
37+
**📡 Listen to connectivity changes in real-time**\
38+
**⚙️ Fully customizable endpoints and success criteria**\
3739
**📱 Cross-platform support** _(Android, iOS, macOS, Linux, Windows, Web)_
3840

3941
This library provides functionality to monitor and verify internet connectivity
@@ -43,13 +45,15 @@ network requests.
4345

4446
## 💝 Support the Project
4547

46-
If this package saved you from the eternal torment of "No Internet Connection" errors, consider buying me a coffee! ☕
48+
If this package saved you from the eternal torment of "No Internet Connection"
49+
errors, consider buying me a coffee! ☕
4750

4851
<a href="https://coff.ee/outdatedguy" target="_blank">
4952
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="102" width="363" />
5053
</a>
5154

52-
_Every coffee helps fuel late-night coding sessions and the occasional existential crisis about whether `null` is a friend or foe._ 🤔☕
55+
_Every coffee helps fuel late-night coding sessions and the occasional
56+
existential crisis about whether `null` is a friend or foe._ 🤔☕
5357

5458
## 🌍 Platform Support
5559

@@ -58,7 +62,8 @@ _Every coffee helps fuel late-night coding sessions and the occasional existenti
5862
| Check Connectivity |||||||
5963
| Listen to Changes |||||||
6064

61-
_Full support across all platforms - because connectivity anxiety is universal!_ 🚀
65+
_Full support across all platforms - because connectivity anxiety is universal!_
66+
🚀
6267

6368
## 📋 Permissions
6469

@@ -113,7 +118,8 @@ final subscription = InternetConnection().onStatusChange.listen(
113118
);
114119
```
115120

116-
_Don't forget to cancel the subscription to prevent memory leaks! Your phone's RAM will thank you._ 🧹
121+
_Don't forget to cancel the subscription to prevent memory leaks! Your phone's
122+
RAM will thank you._ 🧹
117123

118124
## 🎯 Advanced Features
119125

@@ -130,7 +136,8 @@ final connection = InternetConnection.createInstance(
130136
final isConnected = await connection.hasInternetAccess;
131137
```
132138

133-
_Pro tip: Make sure your endpoints have no caching and aren't CORS blocked on web. We learned this the hard way._ 🌐
139+
_Pro tip: Make sure your endpoints have no caching and aren't CORS blocked on
140+
web. We learned this the hard way._ 🌐
134141

135142
### Using custom success criteria
136143

@@ -154,11 +161,13 @@ final connection = InternetConnection.createInstance(
154161
final isConnected = await connection.hasInternetAccess;
155162
```
156163

157-
_Nice status codes! Because sometimes 200 OK is too mainstream for your vibe._ 😎
164+
_Nice status codes! Because sometimes 200 OK is too mainstream for your vibe._
165+
😎
158166

159167
### Using a custom connectivity check method
160168

161-
For advanced use cases, you can completely customize how connectivity checks are performed by providing your own connectivity checker:
169+
For advanced use cases, you can completely customize how connectivity checks are
170+
performed by providing your own connectivity checker:
162171

163172
```dart
164173
final connection = InternetConnection.createInstance(
@@ -186,7 +195,8 @@ final connection = InternetConnection.createInstance(
186195
);
187196
```
188197

189-
This customization gives you full control over the connectivity detection process, allowing you to:
198+
This customization gives you full control over the connectivity detection
199+
process, allowing you to:
190200

191201
- 🔧 Implement platform-specific network detection
192202
- 🔄 Use alternate connectivity checking strategies
@@ -257,17 +267,22 @@ final connection = InternetConnection.createInstance(
257267

258268
> [!CAUTION]
259269
>
260-
> **Use `enableStrictCheck` only with custom-defined URIs, not with the default ones.**
270+
> **Use `enableStrictCheck` only with custom-defined URIs, not with the default
271+
> ones.**
261272
>
262-
> Using it with the default URIs may lead to unreliable results or service outages, as all default endpoints must be up and reachable for a positive result.
273+
> Using it with the default URIs may lead to unreliable results or service
274+
> outages, as all default endpoints must be up and reachable for a positive
275+
> result.
263276
264-
_Strict mode: For the perfectionists who need ALL the endpoints to respond. We won't judge your trust issues._ 💯
277+
_Strict mode: For the perfectionists who need ALL the endpoints to respond. We
278+
won't judge your trust issues._ 💯
265279

266280
## 📡 Built-in and Additional URIs
267281

268282
### Default URIs
269283

270-
The following endpoints are checked by default _(carefully selected for speed and reliability!)_:
284+
The following endpoints are checked by default _(carefully selected for speed
285+
and reliability!)_:
271286

272287
| URI | Description |
273288
| :------------------------------------------- | :--------------------------------------------------------- |
@@ -278,7 +293,8 @@ The following endpoints are checked by default _(carefully selected for speed an
278293

279294
### More Tested URIs
280295

281-
The following URIs are tested and work well with the package _(community approved!)_:
296+
The following URIs are tested and work well with the package _(community
297+
approved!)_:
282298

283299
| URI | Description |
284300
| :----------------------------------------- | :---------------------------------------------- |
@@ -292,32 +308,37 @@ The following URIs are tested and work well with the package _(community approve
292308
| https://lenta.ru | Russia supported, CORS enabled, no-cache |
293309
| https://www.gazeta.ru | Russia supported, CORS enabled, no-cache |
294310

295-
_Feel free to use your own trusted endpoints! We don't judge your API choices._ 🎯
311+
_Feel free to use your own trusted endpoints! We don't judge your API choices._
312+
🎯
296313

297314
## If you liked the package, then please give it a [Like 👍🏼][package] and [Star ⭐][repository]
298315

299316
_Your support keeps this project alive and helps us add more features!_
300317

301318
## 🤝 Contributing
302319

303-
Found a bug? Have a feature request? Want to make the internet more reliable for everyone?
320+
Found a bug? Have a feature request? Want to make the internet more reliable for
321+
everyone?
304322

305323
1. [Check existing issues][issues]
306324
2. [Report bugs][issues_report_bug]
307325
3. [Request features][issues_request_feature]
308326
4. [Submit PRs][pull_requests]
309327

310-
_All contributions welcome! Even if it's just fixing our terrible puns in the docs._ 😅
328+
_All contributions welcome! Even if it's just fixing our terrible puns in the
329+
docs._ 😅
311330

312331
## 📜 License
313332

314333
BSD 3-Clause License - see [LICENSE](LICENSE) file for details.
315334

316-
_TL;DR: Use it, modify it, share it, just don't blame us if your app becomes too reliable._ 😎
335+
_TL;DR: Use it, modify it, share it, just don't blame us if your app becomes too
336+
reliable._ 😎
317337

318338
## 🎁 Easter Egg Hunt
319339

320-
_For the curious developers who actually read READMEs to the end, here's a secret:_ 🕵️
340+
_For the curious developers who actually read READMEs to the end, here's a
341+
secret:_ 🕵️
321342

322343
<details>
323344
<summary>🤖 Click to reveal the truth about this README</summary>
@@ -401,7 +422,8 @@ for checking internet connectivity in Flutter applications.
401422

402423
---
403424

404-
_Made with ❤️ by developers who got tired of "Connected to Wi-Fi" not meaning "Connected to Internet"_
425+
_Made with ❤️ by developers who got tired of "Connected to Wi-Fi" not meaning
426+
"Connected to Internet"_\
405427
_(And polished by an AI that's suspiciously good at puns)_ 🌐✨
406428

407429
<!-- Badges URLs -->

0 commit comments

Comments
 (0)