Skip to content

Commit 1f7abdc

Browse files
committed
docs(README): add test coverage badge.
- Included test coverage badge. Because who doesn't love a shiny new badge? 🥇
1 parent e3dd6bb commit 1f7abdc

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
# Laravel-Elasticsearch
44

55
[![Latest Stable Version](http://img.shields.io/github/release/pdphilip/laravel-elasticsearch.svg)](https://packagist.org/packages/pdphilip/elasticsearch)
6-
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/pdphilip/laravel-elasticsearch/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/pdphilip/laravel-elasticsearch/actions/workflows/run-tests.yml?query=branch%3Amain)
6+
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/pdphilip/laravel-elasticsearch/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/pdphilip/laravel-elasticsearch/actions/workflows/run-tests.yml?query=branch%3Amain)
7+
[![Test Coverage](badge-coverage.svg)](https://packagist.org/packages/pdphilip/elasticsearchy)
78
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/pdphilip/laravel-elasticsearch/phpstan.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/pdphilip/laravel-elasticsearch/actions/workflows/phpstan.yml?query=branch%3Amain++)
89
[![Total Downloads](http://img.shields.io/packagist/dm/pdphilip/elasticsearch.svg)](https://packagist.org/packages/pdphilip/elasticsearch)
10+
911
### Laravel-Elasticsearch: An Elasticsearch implementation of Laravel's Eloquent ORM
1012

1113
This package extends Laravel's Eloquent model and query builder with seamless integration of Elasticsearch functionalities. Designed to feel native to Laravel, this package enables you to work with Eloquent models while leveraging the
@@ -38,10 +40,15 @@ $search = UserProfile::phrase('loves espressos')->highlight()->search();
3840
```
3941

4042
### Read the [Documentation](https://elasticsearch.pdphilip.com/)
43+
4144
---
45+
4246
> #### Using [OpenSearch](https://opensearch.pdphilip.com/)? [Github](https://github.com/pdphilip/laravel-opensearch)
47+
4348
---
49+
4450
> #### [Package Tests](https://github.com/pdphilip/laravel-elasticsearch-tests)
51+
4552
---
4653

4754
## Installation
@@ -55,26 +62,26 @@ composer require pdphilip/elasticsearch
5562
```
5663

5764
| Laravel Version | Command | Maintained |
58-
|-----------------|------------------------------------------------|------------|
59-
| Laravel 10 & 11 | `composer require pdphilip/elasticsearch:~4 ` | |
60-
| Laravel 9 | `composer require pdphilip/elasticsearch:~3.9` | |
61-
| Laravel 8 | `composer require pdphilip/elasticsearch:~3.8` | |
65+
| --------------- | ---------------------------------------------- | ---------- |
66+
| Laravel 10 & 11 | `composer require pdphilip/elasticsearch:~4 ` ||
67+
| Laravel 9 | `composer require pdphilip/elasticsearch:~3.9` ||
68+
| Laravel 8 | `composer require pdphilip/elasticsearch:~3.8` ||
6269

6370
### Unmaintained versions (Elasticsearch 8.x):
6471

6572
| Laravel Version | Command | Maintained |
66-
|-------------------|------------------------------------------------|------------|
67-
| Laravel 7.x | `composer require pdphilip/elasticsearch:~2.7` | |
68-
| Laravel 6.x (5.8) | `composer require pdphilip/elasticsearch:~2.6` | |
73+
| ----------------- | ---------------------------------------------- | ---------- |
74+
| Laravel 7.x | `composer require pdphilip/elasticsearch:~2.7` ||
75+
| Laravel 6.x (5.8) | `composer require pdphilip/elasticsearch:~2.6` ||
6976

7077
### Unmaintained versions (Elasticsearch 7.x):
7178

7279
| Laravel Version | Command | Maintained |
73-
|-------------------|------------------------------------------------|------------|
74-
| Laravel 9.x | `composer require pdphilip/elasticsearch:~1.9` | |
75-
| Laravel 8.x | `composer require pdphilip/elasticsearch:~1.8` | |
76-
| Laravel 7.x | `composer require pdphilip/elasticsearch:~1.7` | |
77-
| Laravel 6.x (5.8) | `composer require pdphilip/elasticsearch:~1.6` | |
80+
| ----------------- | ---------------------------------------------- | ---------- |
81+
| Laravel 9.x | `composer require pdphilip/elasticsearch:~1.9` ||
82+
| Laravel 8.x | `composer require pdphilip/elasticsearch:~1.8` ||
83+
| Laravel 7.x | `composer require pdphilip/elasticsearch:~1.7` ||
84+
| Laravel 6.x (5.8) | `composer require pdphilip/elasticsearch:~1.6` ||
7885

7986
## Configuration
8087

0 commit comments

Comments
 (0)