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.

Sign up for GitHub

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): clean up formatting and verbiage of existing documentation #3105

Merged
merged 1 commit into from
Sep 20, 2024
Merged

docs(search): clean up formatting and verbiage of existing documentation #3105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 17 additions & 5 deletions libs/search/README.md
View file
Open in desktop
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)
Loading