diff --git a/README.md b/README.md index 318db7fe..11f14188 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Angel 3 Framework](./logo3.png)] +[![Angel 3 Framework](./logo3.png)](https://github.com/dukefirehawk/angel) [![version](https://img.shields.io/badge/pub-v4.0.0-brightgreen)](https://pub.dartlang.org/packages/framework) @@ -25,22 +25,22 @@ The availabe features in Angel3 are: See all the packages in the `packages/` directory. ## IMPORTANT NOTES -The migration of Angel Framework to Angel3 framework is still ongoing. About 35 out of 70++ packages have been migrated and tested to be stable and working as expected. Angel3 framework need more testing to get it to production quality. Hence, the Angel3 stable packages have been published with prefix `angel3_` on `pub.dev`for developers to try out. +The migration of Angel Framework to Angel3 Framework is still ongoing. About 35 out of 70++ packages have been migrated and tested to be stable and working as expected. Angel3 framework need more testing to get it to production quality. Hence, the Angel3 stable packages have been published with prefix `angel3_` on `pub.dev`for developers to try out. -In order to acknowledge contributions, AUTHORS.md has been added to every Angel3 packages. This way no matter what the contributions are, be it code review, testing or submit PR, can all be recorded in this file. If you are the original author of the original Angel packages, feel free to send a PR to update that file. +In order to acknowledge contributions, AUTHORS.md has been added to every Angel3 packages. This way no matter what the contributions are, be it code review, testing or submit PR, can all be recorded in this file. If you are the original author of the Angel packages, feel free to send a PR to update that file. Branch: master - Stable version of `angel3` branch Branch: angel3 (Active development) -- Dart version : 2.12.x and above. Use sdk: ">=2.12.0 <3.0.0" +- Dart version : 2.12.x and above. Use sdk: ">=2.12.0 <3.0.0" in pubspec.yml - Publish : Yes. See all packages with `angel3_` prefix on [pub.dev](https://pub.dev/publishers/dukefirehawk.com/packages). - NNDB Support : Yes - Status : Beta - Notes : Basic template is working with the key packages migrated. ORM and GraphQL templates are in progress. Not all packages are fully tested. Branch: sdk-2.12.x-nnbd (Active development) -- Dart version : 2.12.x and above. Use sdk: ">=2.12.0 <3.0.0" +- Dart version : 2.12.x and above. Use sdk: ">=2.12.0 <3.0.0" in pubspec.yml - Publish : No (For NNBD migration and development use only) - NNDB Support : Yes - Status : Beta @@ -52,7 +52,7 @@ For more details, checkout [Project Status](https://github.com/dukefirehawk/ange 1. Download and install [Dart](https://www.dartlang.org/) 2. Download the starter project from [Angel3 Basic Template](https://github.com/dukefirehawk/boilerplates/tree/angel3-basic) -3. Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project. For the current release of Angel3, the existing documents and tutorials for Angel are still relevant and works. In the future, this resources will be updated or migrated accordingly. +3. Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project. For the current release of Angel3, the existing documents and tutorials for Angel are still relevant and works. In the future, these resources will be migrated and updated accordingly.