Skip to content

Commit

Permalink
Add basges to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kpicaza committed Nov 21, 2021
1 parent 6746519 commit cc18b08
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/phpunit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,10 @@ jobs:
run: "composer install --no-interaction --no-progress --no-suggest"

- name: "Tests"
run: "vendor/bin/phpunit"
run: "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-clover coverage.xml"

- name: "Send codecov report0"
uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
files: ./coverage.xml
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# Pheature Flags <br><sub><sup>Laminas Mezzio Toggle management API</sup></sub>

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Type coverage][ico-psalm]][link-psalm]
[![Test Coverage][ico-coverage]][link-coverage]
[![Mutation testing badge][ico-mutant]][link-mutant]
[![Total Downloads][ico-downloads]][link-downloads]
[![Maintainability][ico-maintain]][link-maintain]

## Installation

Describe package installation
Install it using [composer package manager](https://getcomposer.org/download/).

```php
composer require pheature/mezzio-toggle
```

## Getting started

See the docs at main [docs site](https://pheatureflags.io/#/getting-started/laminas-and-mezzio-package).

## Contributing

Your contributions are always welcome! Please have a look at the [contribution guidelines](./CONTRIBUTING.md) first.
Expand All @@ -16,3 +27,16 @@ Your contributions are always welcome! Please have a look at the [contribution g

We really believe in the Open Source Software, we built our carers around it, and we feel that we need to return our
knowledge to the community. For this reason we release all our packages under [BSD-3-Clause licence](./LICENSE.md).

[ico-version]: https://img.shields.io/packagist/v/pheature/mezzio-toggle.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/pheature/mezzio-toggle
[ico-downloads]: https://img.shields.io/packagist/dt/pheature/mezzio-toggle.svg?style=flat-square
[link-downloads]: https://packagist.org/packages/pheature/mezzio-toggle
[ico-psalm]: https://shepherd.dev/github/pheature-flags/mezzio-toggle/coverage.svg
[link-psalm]: https://shepherd.dev/github/pheature-flags/mezzio-toggle
[ico-coverage]: https://codecov.io/gh/pheature-flags/mezzio-toggle/branch/1.0.x/graph/badge.svg?token=DTQIQUZ106
[link-coverage]: https://codecov.io/gh/pheature-flags/mezzio-toggle
[ico-mutant]: https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fpheature-flags%2Fmezzio-toggle%2F1.0.x
[link-mutant]: https://dashboard.stryker-mutator.io/reports/github.com/pheature-flags/mezzio-toggle/1.0.x
[ico-maintain]: https://api.codeclimate.com/v1/badges/7bf71e6da5ed1f93ea07/maintainability
[link-maintain]: https://codeclimate.com/github/pheature-flags/mezzio-toggle/maintainability

0 comments on commit cc18b08

Please sign in to comment.