From d88574fef3dc39f4d69f3455d151cc58a96d18cb Mon Sep 17 00:00:00 2001 From: Felix Angelov Date: Thu, 2 Mar 2023 21:24:41 -0600 Subject: [PATCH] docs: add package descriptions to top-level README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7fbeb5bf..ca6e3c0d 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ https://github.com/shorebirdtech/old_repo This repository is a monorepo containing the following packages: -| Package | -| ----------------------------------------------------------------------------------- | -| [shorebird_cli](packages/shorebird_cli/README.md) | -| [shorebird_code_push_api](packages/shorebird_code_push_api/README.md) | -| [shorebird_code_push_api_client](packages/shorebird_code_push_api_client/README.md) | +| Package | Description | +| ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| [shorebird_cli](packages/shorebird_cli/README.md) | Command-line which allows developers to interact with various Shorebird services | +| [shorebird_code_push_api](packages/shorebird_code_push_api/README.md) | Server which exposes endpoints to support CodePush for Flutter applications | +| [shorebird_code_push_api_client](packages/shorebird_code_push_api_client/README.md) | Dart library which allows Dart applications to interact with the ShoreBird CodePush API | For more information, please refer to the documentation for each package.