Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove FAQ.md and update README.md #386

Merged
merged 1 commit into from
Apr 27, 2023
Merged

docs: remove FAQ.md and update README.md #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 0 additions & 138 deletions FAQ.md
View file
Open in desktop

This file was deleted.

22 changes: 7 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,8 @@ 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](https://github.com/shorebirdtech/install) for
installation instructions.
Shorebird code push is in Open Beta! Instructions for install and usage are at
https://docs.shorebird.dev/

## Packages

Expand All @@ -30,7 +24,6 @@ This repository is a monorepo containing the following packages:
| [shorebird_code_push_protocol](packages/shorebird_code_push_protocol/README.md) | Dart library which contains common interfaces used by Shorebird CodePush |
| [discord_gcp_alerts](packages/discord_gcp_alerts/README.md) | Dart server which forwards GCP alerts to Discord |
| [jwt](packages/jwt/README.md) | Dart library for verifying Json Web Tokens |
| [updater](updater/README.md) | Rust library which handles the CodePush logic and does the real update work |

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

Expand All @@ -45,17 +38,16 @@ If you're interested in contributing, please join us on

Working on Shorebird requires Dart and Rust.

We currently assume the Dart from the Flutter SDK on the 'stable' channel. Due
to the way the Dart compiler works, Shorebird requires an exact version of
Flutter/Dart to operate correctly today.

Once both are installed, `./scripts/bootstrap.sh` will run `pub get` all
packages in the repository.

### Running tests

We don't yet have a script to run tests locally. For now, you can run tests
manually by running `dart test` in a Dart package directory.
We don't yet have a script to run tests locally. For now, we recommend using
`very_good test -r` in the packages directory to run all shorebird tests.

(If you run it in the root, it will find packages in bin/cache/flutter and try
to run tests there, some of which will fail.)

### Tracking coverage

Expand Down