Shorebird Code Push

A Dart package for communicating with the Shorebird Code Push Updater. Use this in your Shorebird app to:

• ✅ Get the currently installed patch version
• ✅ Check whether a new patch is available
• ✅ Download new patches

Getting Started

If your Flutter app does not already use Shorebird, follow our Getting Started Guide to add code push to your app.

Installation

flutter pub add shorebird_code_push

Usage

After adding the package to your pubspec.yaml, you can use it in your app like this:

// Import the library
import 'package:shorebird_code_push/shorebird_code_push.dart';

// Create an instance of the ShorebirdCodePush class
final shorebirdCodePush = ShorebirdCodePush();

// Get the current patch number, or null if no patch is installed.
final currentPatchversion = shorebirdCodePush.currentPatchNumber();

// Check whether a patch is available to install.
final isUpdateAvailable = await shorebirdCodePush.isNewPatchAvailableForDownload();

// Download a new patch.
await shorebirdCodePush.downloadUpdateIfAvailable();

Join us on Discord!

We have an active Discord server where you can ask questions and get help.

Contributing

See CONTRIBUTING.md.