Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hollodotme committed May 4, 2024
1 parent f35d7f7 commit 028c0dd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 11 deletions.
28 changes: 26 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,32 @@ We accept contributions via pull requests on [GitHub](https://github.com/openmet

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

## Running tests
### Install development environment

```bash
$ php vendor/bin/phpunit.phar -c build/
make install
```

### Run PHPStan

```bash
make phpstan
```

### Run PHP-version specific tests

```bash
make test-php-7.2
make test-php-7.3
make test-php-7.4
make test-php-8.0
make test-php-8.1
make test-php-8.2
make test-php-8.3
```

### Run all tests

```bash
make tests
```
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
[![CircleCI](https://circleci.com/gh/openmetrics-php/exposition-text.svg?style=svg)](https://circleci.com/gh/openmetrics-php/exposition-text)
[![Latest Stable Version](https://poser.pugx.org/openmetrics-php/exposition-text/v/stable)](https://packagist.org/packages/openmetrics-php/exposition-text)
[![Total Downloads](https://poser.pugx.org/openmetrics-php/exposition-text/downloads)](https://packagist.org/packages/openmetrics-php/exposition-text)
[![codecov](https://codecov.io/gh/openmetrics-php/exposition-text/branch/master/graph/badge.svg)](https://codecov.io/gh/openmetrics-php/exposition-text)
[![phpstan enabled](https://img.shields.io/badge/phpstan-enabled-green.svg)](https://github.com/phpstan/phpstan)
[![CI and release](https://github.com/openmetrics-php/exposition-text/actions/workflows/ci.yml/badge.svg)](https://github.com/openmetrics-php/exposition-text/actions/workflows/ci.yml)

# OpenMetrics-PHP Exposition Text

Expand All @@ -24,9 +20,15 @@ into existing frameworks / code bases.
**Please note:** that the following content-type header is used for the HTTP response by default
`Content-Type: application/openmetrics-text; charset=utf-8` as [discussed here](https://github.com/OpenObservability/OpenMetrics/issues/79).

## Requirements
## Supported PHP Versions

* PHP >= 7.1
* 7.2
* 7.3
* 7.4
* 8.0
* 8.1
* 8.2
* 8.3

## Installation

Expand Down Expand Up @@ -261,7 +263,6 @@ your_metric_name_summary_count 10

## Contributing

Contributions are welcome and will be fully credited.
Contributions are welcome and will be fully credited.
Please see the [contribution guide](.github/CONTRIBUTING.md) for details.


0 comments on commit 028c0dd

Please sign in to comment.