Merge pull request #12 from vtex-apps/add/recipe

added carousel recipe to docs
vtex-apps · Dec 17, 2019 · 1c8357d · 1c8357d
2 parents ae868db + eca5ee3
commit 1c8357d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+- Recipe about how to use slider-layout as carousel
+
 ## [0.7.2] - 2019-12-05
 
 ## [0.7.1] - 2019-11-25

diff --git a/docs/README.md b/docs/README.md
@@ -4,6 +4,9 @@ Slider-Layout is a flexible solution for building `sliders` of `blocks` within V
 
 ![](https://user-images.githubusercontent.com/27777263/70230361-e839db00-1736-11ea-9f29-7c945c10a5f7.png)
 
+:warning: In order to use the `slider-layout` as a substitute to the `carousel` component, check this [recipe](https://vtex.io/docs/recipes/layout/building-a-carousel-through-lists-and-slider-layout) out.
+
+
 ## Configuration
 
 1. Add the slider-layout app to your theme's dependencies in the `manifest.json`, for example:
@@ -49,6 +52,7 @@ Slider-Layout is a flexible solution for building `sliders` of `blocks` within V
 
 ```
 
+
 | Prop name              | Type                                                       | Description                                                                                                                                                                  | Default value                          |
 | ---------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
 | `label`                | `String`                                                   | Aria label to be used by the `<Slider />` component.                                                                                                                         | `'slider'`                             |