Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ymyzk committed Sep 17, 2019
1 parent 27cc7b0 commit da61892
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ with multiple different Python versions. This project is inspired by
[tox-travis](https://github.com/tox-dev/tox-travis).

## Usage
The following configuration will create 4 jobs when running the worlflow on GitHub Actions.
- On Python 2.7 job, tox runs `py27` environment
- On Python 3.5 job, tox runs `py34` environment
- On Python 3.6 job, tox runs `py35` environment
- On Python 3.7 job, tox runs `py37` and `mypy` environments

`tox.ini`:
```ini
[tox]
Expand Down Expand Up @@ -51,6 +57,10 @@ jobs:
```
## Advanced Usage
The following configuration will create 2 jobs when running the worlflow on GitHub Actions.
- On Python 2.7 job, tox runs `py27-django111` environment
- On Python 3.7 job, tox runs `py37-django111` and `py37-django20` environments

`tox.ini`:
```ini
[tox]
Expand Down

0 comments on commit da61892

Please sign in to comment.