You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
[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.
> __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).
17
22
18
23
---
19
24
20
25
## 🚨 Breaking Changes in v4.0.0
21
26
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.
0 commit comments