Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mit-mit committed Jan 19, 2021
1 parent 6e06870 commit 584dd6f
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,17 @@ This [GitHub Action]() installs and sets up of a Dart SDK for use in actions by:

# Usage

## Basic
## Inputs

The action takes the following inputs:

* `sdk`: Which SDK version to setup. Can be specified using one of two forms:
* A specific SDK version, e.g. `2.7.2` or `2.12.0-1.4.beta`
* A release channel, which will install the latest build from that channel.
Available channels are `stable`, `beta`, `dev`, and `main`. See
https://dart.dev/tools/sdk/archive for details.

## Basic example

Install the latest stable SDK, and run Hello World.

Expand Down Expand Up @@ -37,7 +47,7 @@ jobs:
run: dart bin/hello_world.dart
```
## Check static analysis, formatting, and tests
## Check static analysis, formatting, and test example
Various static checks:
Expand All @@ -62,7 +72,7 @@ Various static checks:
run: dart test
```
## Matrix testing
## Matrix testing example
You can create matrix jobs that run tests on multiple operating systems, and
multiple versions of the Dart SDK.
Expand Down Expand Up @@ -101,7 +111,7 @@ jobs:
run: dart test
```
## Testing older Dart SDKs
## Testing older Dart SDKs example
The Dart SDK continously evolves, and new features and tools are added. The Dart
2.10 SDK introduced a new unified `dart` developer tool, which is what we use in
Expand Down

0 comments on commit 584dd6f

Please sign in to comment.