Skip to content

Commit

Permalink
chore(cozy-dataproxy): Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ldoppea committed Nov 5, 2024
1 parent 342a59e commit d673d74
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions packages/cozy-dataproxy/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# Cozy-dataproxy

## Concept

This library is meant to be used by DataProxy apps like [cozy-web-data-proxy](https://github.com/cozy/cozy-web-data-proxy) or [cozy-flagship-app](https://github.com/cozy/cozy-flagship-app). Its goal is to mutualize data manipulation features like Search indexing

## Installation

Just run

- `yarn add cozy-dataproxy`

## API

### Nomenclature

- `SearchEngine`: Class that can index and search through Cozy's metadata

### Setup and usage

In order to create a SearchEngine:
```ts
const searchEngine = new SearchEngine(client)

// ...

const query = 'Some search string'
const searchResult = searchEngine.search(query)
```

0 comments on commit d673d74

Please sign in to comment.