-
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(search): clean up formatting and verbiage of existing documentat…
…ion (#3105)
- Loading branch information
Showing
1 changed file
with
17 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |