Skip to content

Commit

Permalink
docs(search): clean up formatting and verbiage of existing documentat…
Browse files Browse the repository at this point in the history
…ion (#3105)
  • Loading branch information
xelaint authored Sep 20, 2024
1 parent 0e92c31 commit 87fe43b
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions libs/search/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# @daffodil/search

`@daffodil/search` contains the main features required to build search in an Angular app. `@daffodil/search` doesn't inherently support searching for any particular entities but instead provides base models and extension points that are utilized by other libraries.

See [@daffodil/search-product](../search-product/README.md) for an example of such a library.
`@daffodil/search` contains the main features required to build search in an Angular app. `@daffodil/search` doesn't inherently support searching for any particular entities but instead provides base models and extension points that are utilized by other packages.

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

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

Install with yarn:

```bash
yarn add @daffodil/search
```

## Subpackages

- [@daffodil/search-category](../search-category/README.md)
- [@daffodil/search-product](../search-product/README.md)
- [@daffodil/search-product-composite](../search-product-composite/README.md)
- [@daffodil/search-product-configurable](../search-product-configurable/README.md)

0 comments on commit 87fe43b

Please sign in to comment.