shorebird/README.md

Shorebird 🐦

Home of the Shorebird Tools

Status

We're in the process of converting the quick demos written by one person, into a multi-contributor project usable by others. Previous demo code can be found at: https://github.com/shorebirdtech/old_repo

Getting Started

Refer to shorebird/install for installation instructions.

Packages

This repository is a monorepo containing the following packages:

Package	Description
shorebird_cli	Command-line which allows developers to interact with various Shorebird services
shorebird_code_push_api	Server which exposes endpoints to support CodePush for Flutter applications
shorebird_code_push_api_client	Dart library which allows Dart applications to interact with the ShoreBird CodePush API
shorebird_code_push_updater	Rust library which handles the CodePush logic and does the real update work

For more information, please refer to the documentation for each package.

❗️ Note: This project is under heavy development. Things will change frequently and none of the code is ready for production use. We will do our best to keep the documentation up-to-date.

Contributing

If you're interested in contributing, please join us on Discord.

License

Shorebird projects are licensed for use under either Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.

See our license philosophy for more information on why we license files this way: https://github.com/shorebirdtech/handbook/blob/main/engineering.md#licensing-philosophy