docs: add package descriptions to top-level README

This commit is contained in:
Felix Angelov
2023-03-02 21:24:41 -06:00
parent f0c3af8b96
commit d88574fef3
+5 -5
View File
@@ -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.