Chore: Revise README for better structure and links (#303)

Updated README.md to improve branding, formatting and clarity.
This commit is contained in:
dawn-ducky
2025-12-03 16:50:36 -06:00
committed by GitHub
parent 76f005940d
commit 504a0af1f6
+17 -8
View File
@@ -1,4 +1,7 @@
# Shorebird Code Push
<div align=center>
<img src= "https://raw.githubusercontent.com/shorebirdtech/brand/904722544742c13348f1854a5cc45f4ed223cd17/logo-wordmark/logo_wordmark.png" alt="Shorebird logo">
<h1>Code Push </h1>
[![Discord](https://img.shields.io/discord/1030243211995791380?style=for-the-badge&logo=discord&color=blue)](https://discord.gg/shorebird)
@@ -6,17 +9,24 @@
[![codecov](https://codecov.io/gh/shorebirdtech/updater/branch/main/graph/badge.svg)](https://codecov.io/gh/shorebirdtech/updater)
[![License: MIT][license_badge]][license_link]
A Dart package for communicating with the [Shorebird](https://shorebird.dev)
Code Push Updater. Use this in your Shorebird app to:
<p align=center> Instantly push updates to your Flutter app without lengthy app store review cycles. </p>
[Website](https://shorebird.dev?utm_source=pubdev) • [Docs](https://docs.shorebird.dev?utm_source=pubdev) • [X](https://x.com/shorebirddev)• [YouTube](https://www.youtube.com/@shorebird)
</div>
This Dart package communicates with the [Shorebird](https://shorebird.dev) Code Push Updater to:
- ✅ Get the currently installed patch version
- ✅ Check whether a new patch is available
- ✅ Download new patches
## Demo
Explore this [interactive demo](https://docs.shorebird.dev/code-push/?utm_source=pubdev) to learn more
## Getting Started
If your Flutter app does not already use Shorebird, follow our
[Getting Started Guide](https://docs.shorebird.dev/) to add code push to your
[Getting Started Guide]([https://docs.shorebird.dev/getting-started/?utm_source=pubdev]) to add code push to your
app.
## Installation
@@ -86,10 +96,9 @@ See the example for a complete working app.
### Tracks
Shorebird also supports publishing patches to different tracks, which can be
used to target different segments of your user base. See
https://docs.shorebird.dev/code-push/guides/percentage-based-rollouts/ for a
guide on using this functionality to implement percentage-based rollouts.
Shorebird supports publishing patches to different tracks, which can be
used to target different segments of your user base. See the [percentage based rollout
guide](https://docs.shorebird.dev/code-push/guides/percentage-based-rollouts/) for implementation details.
You must first publish a patch to a specific track (patches are published to the
`stable` track by default). To publish a patch to a different track, update your