Prepare release (#3)

codetent · May 30, 2022 · d619715 · d619715
1 parent 19eec36
commit d619715
Show file tree

Hide file tree

Showing 5 changed files with 170 additions and 149 deletions.
diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
 
     runs-on: ${{ matrix.os }}
     steps:
@@ -35,7 +35,7 @@ jobs:
     - name: Archive artifacts
       uses: actions/upload-artifact@v3
       with:
-        name: yastr
+        name: ${{ matrix.os }}
         path: |
           dist/yastr
           dist/yastr.*

diff --git a/README.md b/README.md
@@ -1,13 +1,19 @@
 <div align="center">
-  <img src="doc/logo.svg" width="100" /><br>
+  <br>
+  <img src="https://raw.githubusercontent.com/codetent/yastr/main/doc/logo.svg" width="100" /><br>
 
   # <b>Y</b>et <b>A</b>nother <b>S</b>imple <b>T</b>est <b>R</b>unner
 
   A simple test runner for just calling executables and generating reports.
   <br/><br/>
-
 </div>
 
+![PyPI](https://img.shields.io/pypi/v/yastr)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/yastr)
+![PyPI - License](https://img.shields.io/pypi/l/yastr)
+[![Python package](https://github.com/codetent/yastr/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/codetent/yastr/actions/workflows/python-package.yml)
+[![Packaging](https://github.com/codetent/yastr/actions/workflows/packaging.yml/badge.svg?branch=main)](https://github.com/codetent/yastr/actions/workflows/packaging.yml)
+
 ## Description
 
 YASTR is a utility that gets the testing job quickly done without requiring a specific test framework. Instead just having an executable that shall be executed is enough.
@@ -35,8 +41,8 @@ And it supports everything that pytest offers:
 
 ## Documentation
 
-- Quickstart: [doc/guide/quickstart.md](doc/guide/quickstart.md)
-- Advanced: [doc/guide/advanced.md](doc/guide/advanced.md)
+- Quickstart: [doc/guide/quickstart.md](https://github.com/codetent/yastr/blob/main/doc/guide/quickstart.md)
+- Advanced: [doc/guide/advanced.md](https://github.com/codetent/yastr/blob/main/doc/guide/advanced.md)
 
 ## Installation
 

diff --git a/doc/guide/quickstart.md b/doc/guide/quickstart.md
@@ -18,7 +18,7 @@ information required for the test case:
 
 ```yaml
 executable: python
-args: [-c, "import os; print(os.environ['VAR']")]
+args: [-c, "import os; print(os.environ['VAR'])"]
 environment:
     VAR: foobar
 ```