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 2022-04-24 08:55:17 +08:00
parent 38073e5b61
commit ab2c8d0ad2
42 changed files with 41 additions and 80 deletions
packages
auth
.travis.yml
configuration
.travis.yml
cors
.travis.yml
hot
README.md
jael
README.md
angel_jael
README.md
jael
CHANGELOG.mdREADME.md
jael_preprocessor
CHANGELOG.mdREADME.md
travis.sh
markdown
.travis.ymlREADME.md
mock_request
.travis.yml
mustache
.travis.ymlREADME.md
oauth2
.travis.ymlREADME.md
orm
angel_migration
README.md
angel_migration_runner
README.md
angel_orm
README.mdmono_pkg.yaml
angel_orm_generator
README.md
angel_orm_mysql
CHANGELOG.mdREADME.md
angel_orm_postgres
README.md
angel_orm_service
README.md
paginate
README.md
redis
.travis.ymlREADME.md
route
.travis.yml
security
.gitattributes.travis.yml
sembast
.travis.ymlREADME.md
shelf
.travis.yml
static
.travis.ymlREADME.md
sync
.travis.yml
test
.travis.yml
validate
.travis.yml
websocket
.travis.yml

4
packages/auth/.travis.yml
View file

@ -1,4 +0,0 @@
language: dart
dart:
- dev
- stable

3
packages/configuration/.travis.yml
View file

@ -1,3 +0,0 @@
language: dart
dart:
- stable

1
packages/cors/.travis.yml
View file

@ -1 +0,0 @@
language: dart

4
packages/hot/README.md
View file

@ -18,8 +18,8 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_framework: ^4.2.0 angel3_framework: ^6.0.0
angel3_hot: ^4.3.0 angel3_hot: ^6.0.0
``` ```
## Usage ## Usage

7
packages/jael/README.md
View file

@ -14,15 +14,13 @@ Though its syntax is but a superset of HTML, it supports features such as:
* `switch` syntax * `switch` syntax
* Interpolation of any Dart expression * Interpolation of any Dart expression
Jael is a good choice for applications of any scale, especially when the development team is small, or the time invested in building an SPA would be too much. Jael3 is a good choice for applications of any scale, especially when the development team is small, or the time invested in building an SPA would be too much.
## Documentation ## Documentation
Each of the [packages within this repository](#this-repository) contains some sort of documentation. Each of the [packages within this repository](#this-repository) contains some sort of documentation.
Documentation for Jael syntax and directives has been Documentation for Jael syntax and directives has been **moved** to the [Angel3 framework wiki](https://angel3-docs.dukefirehawk.com/packages/front-end/jael).
**moved** to the
[Angel3 framework wiki](https://angel3-docs.dukefirehawk.com/packages/front-end/jael).
## This Repository ## This Repository
@ -31,4 +29,3 @@ Within this repository are three packages:
* `package:jael3` - Contains the Jael parser, AST, and HTML renderer. * `package:jael3` - Contains the Jael parser, AST, and HTML renderer.
* `package:jael3_preprocessor` - Handles template inheritance, and facilitates the use of "compile-time" constructs. * `package:jael3_preprocessor` - Handles template inheritance, and facilitates the use of "compile-time" constructs.
* `package:angel3_jael` - [Angel3](https://angel3-framework.web.app/) support for Jael. * `package:angel3_jael` - [Angel3](https://angel3-framework.web.app/) support for Jael.
facilities to speed up application development, so something like Jael is right at home.

2
packages/jael/angel_jael/README.md
View file

@ -13,7 +13,7 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_jael: ^4.2.0 angel3_jael: ^6.0.0
``` ```
## Usage ## Usage

6
packages/jael/jael/CHANGELOG.md
View file

@ -1,8 +1,12 @@
# Change Log # Change Log
## 6.0.0
* Updated to SDK 2.16.x
## 5.0.0 ## 5.0.0
* Updated to SDK 2.16.x * Skipped release
## 4.2.0 ## 4.2.0

2
packages/jael/jael/README.md
View file

@ -15,7 +15,7 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
jael3: ^4.2.0 jael3: ^6.0.0
``` ```
## API ## API

6
packages/jael/jael_preprocessor/CHANGELOG.md
View file

@ -1,8 +1,12 @@
# Change Log # Change Log
## 6.0.0
* Updated to SDK 2.16.x
## 5.0.0 ## 5.0.0
* Updated to SDK 2.16.x * Skipped release
## 4.2.0 ## 4.2.0

2
packages/jael/jael_preprocessor/README.md
View file

@ -13,7 +13,7 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
jael3_prepreprocessor: ^4.2.0 jael3_prepreprocessor: ^6.0.0
``` ```
## Usage ## Usage

7
packages/jael/travis.sh
View file

@ -1,7 +0,0 @@
#!/usr/bin/env bash
# Fast-fail on errors
set -e
cd jael && pub get && pub run test
cd ../jael_preprocessor/ && pub get && pub run test
cd ../angel_jael/ && pub get && pub run test

1
packages/markdown/.travis.yml
View file

@ -1 +0,0 @@
language: dart

4
packages/markdown/README.md
View file

@ -15,8 +15,8 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_framework: ^4.2.0 angel3_framework: ^6.0.0
angel3_markdown: ^3.0.0 angel3_markdown: ^6.0.0
``` ```
## Usage ## Usage

1
packages/mock_request/.travis.yml
View file

@ -1 +0,0 @@
language: dart

1
packages/mustache/.travis.yml
View file

@ -1 +0,0 @@
language: dart

2
packages/mustache/README.md
View file

@ -15,7 +15,7 @@ In `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_mustache: ^3.1.0 angel3_mustache: ^6.0.0
``` ```
## Usage ## Usage

4
packages/oauth2/.travis.yml
View file

@ -1,4 +0,0 @@
language: dart
dart:
- dev
- stable

4
packages/oauth2/README.md
View file

@ -20,8 +20,8 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_framework: ^4.2.0 angel3_framework: ^6.0.0
angel3_oauth2: ^4.1.0 angel3_oauth2: ^6.0.0
``` ```
## Usage ## Usage

2
packages/orm/angel_migration/README.md
View file

@ -10,5 +10,5 @@ A database migration framework built for Angel3 ORM.
## Supported database ## Supported database
* PostgreSQL version 10 or later * PostgreSQL version 10 or later
* MySQL 8.0.x
* MariaDB 10.2.x * MariaDB 10.2.x
* MySQL 8.x

2
packages/orm/angel_migration_runner/README.md
View file

@ -10,5 +10,5 @@ Command-line based database migration runner for Angel3 ORM.
Supported database: Supported database:
* PostgreSQL version 10 or later * PostgreSQL version 10 or later
* MySQL 8.0.x
* MariaDB 10.2.x * MariaDB 10.2.x
* MySQL 8.x

4
packages/orm/angel_orm/README.md
View file

@ -9,8 +9,8 @@ Runtime support for Angel3 ORM. Includes a clean, database-agnostic query builde
## Supported database ## Supported database
* PostgreSQL version 10, 11, 12, 13 and 14 * PostgreSQL version 10 or later
* MariaDB 10.2.x * MariaDB 10.2.x
* MySQL 8.0.x * MySQL 8.x
For documentation about the ORM, see [Developer Guide](https://angel3-docs.dukefirehawk.com/guides/orm) For documentation about the ORM, see [Developer Guide](https://angel3-docs.dukefirehawk.com/guides/orm)

0
packages/orm/angel_orm/mono_pkg.yaml
View file

2
packages/orm/angel_orm_generator/README.md
View file

@ -23,3 +23,5 @@ Run the following command to generate the required `.g.dart` files for Angel3 OR
## Supported database ## Supported database
* PostgreSQL version 10 or later * PostgreSQL version 10 or later
* MariaDB 10.2.x
* MySQL 8.x

2
packages/orm/angel_orm_mysql/CHANGELOG.md
View file

@ -1,6 +1,6 @@
# Change Log # Change Log
## 6.0.0-bata.1 ## 6.0.0-beta.1
* Updated to SDK 2.16.x * Updated to SDK 2.16.x
* Added support for MariaDB 10.2.x with `mysql1` driver * Added support for MariaDB 10.2.x with `mysql1` driver

4
packages/orm/angel_orm_mysql/README.md
View file

@ -12,12 +12,12 @@ This package contains the SQL Executor required by Angel3 ORM to work with MySQL
## Supported database version ## Supported database version
* MySQL 8.x
* MariaDb 10.2.x * MariaDb 10.2.x
* MySQL 8.x
**Note** MySQL below version 8.0 and MariaDB below version 10.2 are not supported as Angel3 ORM requires common table expressions (CTE). **Note** MySQL below version 8.0 and MariaDB below version 10.2 are not supported as Angel3 ORM requires common table expressions (CTE).
## Connecting to MySQL database 8.x.x ## Connecting to MySQL database 8.x
```dart ```dart
import 'package:mysql_client/mysql_client.dart'; import 'package:mysql_client/mysql_client.dart';

8
packages/orm/angel_orm_postgres/README.md
View file

@ -1,14 +1,14 @@
# Angel3 ORM for Postgresql # Angel3 ORM for PostgreSQL
![Pub Version (including pre-releases)](https://img.shields.io/pub/v/angel3_orm_postgres?include_prereleases) ![Pub Version (including pre-releases)](https://img.shields.io/pub/v/angel3_orm_postgres?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/angel_dart/discussion)](https://gitter.im/angel_dart/discussion) [![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)
[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/master/packages/orm/angel_orm_postgres/LICENSE) [![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/master/packages/orm/angel_orm_postgres/LICENSE)
Postgresql support for Angel3 ORM. PostgreSQL support for Angel3 ORM.
## Supported PosgtreSQL ## Supported database
* version 10 or later * PostgreSQL version 10 or later
For documentation about the ORM, see [Developer Guide](https://angel3-docs.dukefirehawk.com/guides/orm) For documentation about the ORM, see [Developer Guide](https://angel3-docs.dukefirehawk.com/guides/orm)

2
packages/orm/angel_orm_service/README.md
View file

@ -13,7 +13,7 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_orm_service: ^2.0.0 angel3_orm_service: ^6.0.0
``` ```
## Usage ## Usage

2
packages/paginate/README.md
View file

@ -13,7 +13,7 @@ In your `pubspec.yaml` file:
```yaml ```yaml
dependencies: dependencies:
angel3_paginate: ^3.1.0 angel3_paginate: ^6.0.0
``` ```
## Usage ## Usage

3
packages/redis/.travis.yml
View file

@ -1,3 +0,0 @@
language: dart
services:
- redis-server

4
packages/redis/README.md
View file

@ -17,8 +17,8 @@ In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_framework: ^4.2.0 angel3_framework: ^6.0.0
angel3_redis: ^2.0.0 angel3_redis: ^6.0.0
``` ```
## Usage ## Usage

3
packages/route/.travis.yml
View file

@ -1,3 +0,0 @@
language: dart
dart:
- stable

1
packages/security/.gitattributes vendored
View file

@ -1 +0,0 @@
libinjection/* linguist-vendored

1
packages/security/.travis.yml
View file

@ -1 +0,0 @@
language: dart

1
packages/sembast/.travis.yml
View file

@ -1 +0,0 @@
language: dart

2
packages/sembast/README.md
View file

@ -13,7 +13,7 @@ Add the following to your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_sembast: ^3.0.0 angel3_sembast: ^6.0.0
``` ```
## Usage ## Usage

1
packages/shelf/.travis.yml
View file

@ -1 +0,0 @@
language: dart

4
packages/static/.travis.yml
View file

@ -1,4 +0,0 @@
language: dart
dart:
- dev
- stable

2
packages/static/README.md
View file

@ -13,7 +13,7 @@ In `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
angel3_static: ^4.0.0 angel3_static: ^6.0.0
``` ```
## Usage ## Usage

1
packages/sync/.travis.yml
View file

@ -1 +0,0 @@
language: dart

4
packages/test/.travis.yml
View file

@ -1,4 +0,0 @@
language: dart
dart:
- dev
- stable

1
packages/validate/.travis.yml
View file

@ -1 +0,0 @@
language: dart

4
packages/websocket/.travis.yml
View file

@ -1,4 +0,0 @@
language: dart
dart:
- dev
- stable