From 7ff50214915ce8b27427d10e2f55d2d9375161ca Mon Sep 17 00:00:00 2001 From: thomashii Date: Sat, 13 Mar 2021 10:32:48 +0800 Subject: [PATCH] Updated README.md --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5507b230..5b12d905 100644 --- a/README.md +++ b/README.md @@ -25,27 +25,36 @@ See all the packages in the `packages/` directory. ## IMPORTANT NOTES This is a port of Angel Framework to work with Dart 2.10.x and above. Dart version below 2.10.x is not supported. +Branch: master +- Stable version of sdk-2.12.x branch + Branch: sdk-2.10.x - Support dart 2.10.x only. Use sdk: ">=2.10.0 <2.12.0" -- Status: Working. Not all plugin packages are tested. +- Status: Migration completed. Not all plugin packages are tested. Branch: sdk-2.12.x - Support dart 2.12.x. Use sdk: ">=2.10.0 <3.0.0" - Do not support NNBD -- Status: Working. Not all plugin packages are migrated and tested. +- Status: Basic and ORM templates are working with the core plugins migration completed. The remaining add on plugin packages are work in progress. -Branch: adk-2.12.x-nnbd +Branch: sdk-2.12.x-nnbd - Support dart 2.12.x. Use sdk: ">=2.12.0 <3.0.0" - Support NNBD -- Status: To be available once all the dependency libraries support NNBD +- Status: Not working yet. To be available once all the dependency libraries that support NNBD are released -New features planned +Changes involved: +- Upgraded dependency libraries and fixed the deprecated API + +Deprecated features: - None -To install Angel CLI, run the following command after install dart sdk +New features: +- To be decided + +To install Angel CLI, run the following command after installing dart sdk `dart pub global activate --source git https://github.com/dukefirehawk/angel/packages/cli` -To use local development version of Angel CLI, run the following command after install dart sdk +To use local development version of Angel CLI, run the following command after installing dart sdk `dart pub global activate --source path ./packages/cli`