Updated README
This commit is contained in:
parent
926ab3fabc
commit
d80798d535
2 changed files with 17 additions and 25 deletions
|
@ -1,4 +1,4 @@
|
||||||
# 3.0.1 (NNBD)
|
# 4.0.0 (NNBD)
|
||||||
* Changed Dart SDK requirements for all packages to ">=2.12.0 <3.0.0" to support NNBD.
|
* Changed Dart SDK requirements for all packages to ">=2.12.0 <3.0.0" to support NNBD.
|
||||||
* Updated pretty_logging to 2.0.0
|
* Updated pretty_logging to 2.0.0
|
||||||
* Updated angel_http_exception to 2.0.0
|
* Updated angel_http_exception to 2.0.0
|
||||||
|
|
40
README.md
40
README.md
|
@ -23,36 +23,28 @@ With features like the following, Angel is the all-in-one framework you should c
|
||||||
See all the packages in the `packages/` directory.
|
See all the packages in the `packages/` directory.
|
||||||
|
|
||||||
## IMPORTANT NOTES
|
## 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.
|
This is a port of Angel Framework to work with Dart SDK 2.12.x and above. Dart SDK 2.12.x and below are not supported.
|
||||||
|
|
||||||
Branch: master
|
Branch: master
|
||||||
- Stable version of sdk-2.12.x branch
|
- Same as 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
|
|
||||||
- Notes: Migration completed. Not all plugin packages are tested.
|
|
||||||
|
|
||||||
Branch: sdk-2.12.x
|
Branch: sdk-2.12.x
|
||||||
- Support dart 2.12.x. Use sdk: ">=2.10.0 <3.0.0"
|
- Required Dart SDK: ">=2.10.0 <3.0.0"
|
||||||
- Do not support NNBD
|
- NNBD Support: No
|
||||||
- Status: Working
|
- Status: Production
|
||||||
- Notes: Basic and ORM templates are working with the core plugins migration completed. The remaining add on plugin packages are work in progress.
|
- Notes: Not all packages are fully tested. Refer to WIKI page for details. The Basic and ORM boilerplates are working and can be found at https://github.com/dukefirehawk/boilerplates under "basic-sdk-2.12.x" and "orm-sdk-2.12.x" branch respectively.
|
||||||
|
|
||||||
Branch: sdk-2.12.x-nnbd
|
Branch: sdk-2.12.x_nnbd
|
||||||
- Support dart 2.12.x. Use sdk: ">=2.12.0 <3.0.0"
|
- Required Dart SDK: ">=2.12.0 <3.0.0"
|
||||||
- Support NNBD
|
- NNBD Support: Yes
|
||||||
- Status: Not working
|
- Status: Development
|
||||||
- Notes: To be available once all the dependency libraries that support NNBD are released
|
- Notes: Migration and code refactoring in progress. Refer to WIKI page for details.
|
||||||
|
|
||||||
Changes:
|
Branch: sdk-2.10.x
|
||||||
- Upgraded dependency libraries and fixed the deprecated API
|
- Required Dart SDK: ">=2.10.0 <2.12.0"
|
||||||
|
- NNBD support: No
|
||||||
Deprecated Features:
|
- Status: Retired
|
||||||
- None
|
- Notes: Upgrade completed. Not all packages are fully tested. This branch is the baseline used in migrating the framework to Dart SDK 2.12.x. It may still work with Dart SDK 2.10.x but no longer maintained.
|
||||||
|
|
||||||
New features:
|
|
||||||
- None
|
|
||||||
|
|
||||||
## Installation & Setup
|
## Installation & Setup
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue