Skip to content

Commit 92b0c42

Browse files
authored
docs(product-configurable): clean up formatting and verbiage of existing documentation (#3093)
1 parent 81ac902 commit 92b0c42

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

libs/product-configurable/README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# @daffodil/product-configurable
2-
3-
Building and maintaining a model and code for an ecommerce store is complex and mentally taxing. `@daffodil/product-configurable`
4-
provides clear interfaces, models, and factories for the frontend of an ecommerce store so that you don't have to.
5-
2+
`@daffodil/product-configurable` simplifies the management of configurable products and is intended for use in conjunction with `@daffodil/product`.
63

74
## Installation
5+
To install `@daffodil/product-configurable`, use the following commands in your terminal.
86

7+
Install with npm:
8+
```bash
9+
npm install @daffodil/product-configurable --save
910
```
10-
npm install @daffodil/product-configurable
11+
12+
Install with yarn:
13+
14+
```bash
15+
yarn add @daffodil/product-configurable
1116
```
1217

13-
The `@daffodil/product-configurable` package is intended for use in conjuction with the `@daffodil/product` package. After installing the `@daffodil/product` package, import the `DaffConfigurableProductStateModule`. This module will add the `DAFF_CONFIGURABLE_PRODUCT_STORE_FEATURE_KEY` to the app root redux state along with configurable product state.
18+
## Getting started
19+
Import the `DaffConfigurableProductStateModule`. This module will add the `DAFF_CONFIGURABLE_PRODUCT_STORE_FEATURE_KEY` to the app root redux state along with configurable product state.
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Driver
2-
The `@daffodil/product-configurable` does not provide its own driver. Instead, this package hooks into extension mechanisms exposed by the `@daffodil/product` package to extend the `@daffodil/product` driver via a provided module.
2+
`@daffodil/product-configurable` does not provide its own driver. Instead, it hooks into extension mechanisms exposed by `@daffodil/product` to extend the `@daffodil/product` driver via a provided module.
33

44
## Magento
5-
To provide both a configurable product fragment and a configurable product transformer to the `@daffodil/product` magento driver, simply import `DaffConfigurableProductMagentoDriverModule` into the app. Both the configurable product magento graphql fragment and the associated transformer are defined by `@daffodil/product-configurable/driver/magento` and are provided to the `@daffodil/product` magento driver through the `DaffConfigurableProductMagentoDriverModule`.
5+
To provide both a configurable product fragment and a configurable product transformer to the `@daffodil/product` Magento driver, simply import `DaffConfigurableProductMagentoDriverModule` into the app. Both the configurable product Magento GraphQL fragment and the associated transformer are defined by `@daffodil/product-configurable/driver/magento` and are provided to the `@daffodil/product` Magento driver through the `DaffConfigurableProductMagentoDriverModule`.

0 commit comments

Comments
 (0)