Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcc007 committed Mar 17, 2019
1 parent 76e4eb1 commit d3eb928
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

_A sylph is a mythological invisible being of the air._
[Wikipedia](https://en.wikipedia.org/wiki/Sylph)
# Sylph
_Sylph_ is a command line ultility for running Flutter integration and end-to-end tests on pools of real devices in the cloud.
# _Sylph_
_Sylph_ is a command line utility for running Flutter integration and end-to-end tests on pools of real devices in the cloud.

# Installation
```
Expand All @@ -21,8 +21,8 @@ sylph -c <path to config file>
```

# Configuration
All configuration information is passed to Sylph using a configuration file. The default config file is called `sylph.yaml`:
```
All configuration information is passed to _Sylph_ using a configuration file. The default config file is called `sylph.yaml`:
```yaml
project_name: flutter tests
default_job_timeout: 5 # minutes

Expand Down Expand Up @@ -53,8 +53,18 @@ test_suites:
# - ios pool 1
job_timeout: 5 # minutes
```
# Live demo
To see _Sylph_ in action, a live demo is available.
The log of the live run is here:
https://travis-ci.com/mmcc007/sylph
The resulting artifacts are here:
https://github.com/mmcc007/sylph/releases
(includes a video of test running on device)
# Limitations
Due to mismatch between Flutter and AWS tooling, Sylph currently is limited to working only on pools of android devices on AWS Device Farms.
Due to mismatch between Flutter and AWS Device Farm tooling, _Sylph_ currently is limited to working only on pools of android devices.
# Contributing
When contributing to this repository, please feel free to discuss via issue or pull request.
Expand Down

0 comments on commit d3eb928

Please sign in to comment.