Skip to content

Commit 385b2f2

Browse files
committed
docs: update README with current badges and installation
- Replace outdated Greenkeeper, Travis CI, and David badges - Add GitHub Actions CI badge - Update installation command to include @elastic/elasticsearch - Add compatibility section for Feathers v5, ES 8.x/9.x, Node 18+ - Clarify v4.0.0 includes Feathers v5 migration
1 parent babc567 commit 385b2f2

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
11
# feathers-elasticsearch
22

3-
[![Greenkeeper badge](https://badges.greenkeeper.io/feathersjs-ecosystem/feathers-elasticsearch.svg)](https://greenkeeper.io/)
4-
5-
[![Build Status](https://travis-ci.org/feathersjs-ecosystem/feathers-elasticsearch.svg?branch=master)](https://travis-ci.org/feathersjs-ecosystem/feathers-elasticsearch)
6-
[![Dependency Status](https://david-dm.org/feathersjs-ecosystem/feathers-elasticsearch/status.svg)](https://david-dm.org/feathersjs-ecosystem/feathers-elasticsearch)
3+
[![CI](https://github.com/feathersjs-ecosystem/feathers-elasticsearch/actions/workflows/test-matrix.yml/badge.svg)](https://github.com/feathersjs-ecosystem/feathers-elasticsearch/actions/workflows/test-matrix.yml)
4+
[![npm version](https://img.shields.io/npm/v/feathers-elasticsearch.svg)](https://www.npmjs.com/package/feathers-elasticsearch)
75
[![Download Status](https://img.shields.io/npm/dm/feathers-elasticsearch.svg?style=flat-square)](https://www.npmjs.com/package/feathers-elasticsearch)
86

9-
[feathers-elasticsearch](https://github.com/feathersjs-ecosystem/feathers-elasticsearch/) is a database adapter for [Elasticsearch](https://www.elastic.co/products/elasticsearch). This adapter is not using any ORM, it is dealing with the database directly through the [elasticsearch.js client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/quick-start.html).
7+
A [Feathers](https://feathersjs.com) database adapter for [Elasticsearch](https://www.elastic.co/elasticsearch/). This adapter provides a direct interface to Elasticsearch using the official [@elastic/elasticsearch](https://www.npmjs.com/package/@elastic/elasticsearch) client.
108

9+
## Installation
1110

1211
```bash
13-
$ npm install --save elasticsearch feathers-elasticsearch
12+
npm install feathers-elasticsearch @elastic/elasticsearch --save
1413
```
1514

16-
> __Important:__ `feathers-elasticsearch` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).
15+
## Compatibility
16+
17+
- **Feathers v5** (Dove)
18+
- **Elasticsearch 8.x and 9.x**
19+
- **Node.js 18+**
20+
21+
> **Important:** `feathers-elasticsearch` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).
1722
1823
---
1924

2025
## 🚨 Breaking Changes in v4.0.0
2126

22-
Version 4.0.0 introduces significant **security improvements** that include breaking changes. Please review the migration guide below.
27+
Version 4.0.0 introduces **Feathers v5 compatibility**, significant **security improvements**, and **performance optimizations**. Please review the migration guide below.
2328

2429
### What Changed
2530

0 commit comments

Comments
 (0)