Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(search-product): clean up formatting and verbiage of existing documentation #3103

Merged
merged 1 commit into from
Sep 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions libs/search-product/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# @daffodil/search-product

An optional package which adds the product feature onto the `@daffodil/search` package.

It enables searching for products in your specified platform via `@daffodil/search/driver/federated` and stores product entities via `@daffodil/product/state`.
`@daffodil/search-product` enables product searches on your specified platform using the `@daffodil/search/driver/federated` driver and stores product entities via `@daffodil/product/state`. It's an optional package that adds the product feature on to `@daffodil/search`.

## Installation
To install `@daffodil/search-product`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/search-product --save
```
npm install @daffodil/search-product

Install with yarn:

```bash
yarn add @daffodil/search-product
```
Loading