mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
thomashii 2021-12-21 09:11:53 +08:00
parent 2a6536c5c1
commit 70e6f1b6c1
2 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -2,10 +2,9 @@
[![Angel3 Framework](./logo3.png)](https://github.com/dukefirehawk/angel) [![Angel3 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) ![Pub Version (including pre-releases)](https://img.shields.io/pub/v/angel3_framework?include_prereleases)
[![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety) [![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion)
[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/LICENSE) [![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/LICENSE)
**A polished, production-ready backend framework in Dart with NNBD support.** **A polished, production-ready backend framework in Dart with NNBD support.**
@ -106,6 +105,14 @@ For more details, checkout [Project Status](https://github.com/dukefirehawk/ange
Check out [Migrating to Angel3](https://angel3-docs.dukefirehawk.com/migration/angel-2.x.x-to-angel3/migration-guide-3) Check out [Migrating to Angel3](https://angel3-docs.dukefirehawk.com/migration/angel-2.x.x-to-angel3/migration-guide-3)
## Performance Benchmark
The performance benchmark can be found at
[TechEmpower Framework Benchmarks](https://tfb-status.techempower.com/)
The test cases are build using standard `Angel3 ORM` template. Note that JAEL view template caching is not enabled in `Fortunes` test case and database connections pooling is not used in any of the queries test cases. These results will be used for fine-tuning the framework.
## Examples and Documentation ## Examples and Documentation
Visit the [User Guide](https://angel3-docs.dukefirehawk.com/) for dozens of guides and resources, including video tutorials, to get up and running as quickly as possible with Angel3 framework. Visit the [User Guide](https://angel3-docs.dukefirehawk.com/) for dozens of guides and resources, including video tutorials, to get up and running as quickly as possible with Angel3 framework.

11
TODO.md
View file

@ -4,12 +4,11 @@
* Update examples * Update examples
* Update User Guide * Update User Guide
* Performance testing * Fix bugs
## Long Term Goal ## Long Term Goal
* Optimise Angel3 architecture * Refactor Angel3 architecture for performance and security
* Better logging for error messages
### In Progress * Improve exception and error handling
* Improve ORM features
* Migrate generic packages that has no dependencies on Angel3 to [Common Utilities Repository](<https://github.com/dart-backend/belatuk-common-utilities>). All of these packages operate under the hood with no impact to the application build on Angel3. Updating to newer version of Angel3 packages will automatically upgrade them.