Skip to content

Commit

Permalink
Added documentation about vtex install and Plug & Play disclaimer (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrsmutti authored Dec 16, 2019
1 parent 84ca0ce commit 1487c63
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Changed

- Improve documentation.

## [0.3.3] - 2019-12-11

### Changed

- Improve documentation.

## [0.3.2] - 2019-12-09

### Fixed
Expand Down
23 changes: 22 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ a more complete search experience.

## Usage

This app uses our store builder with the blocks architecture. To know more about Store Builder [click here.](https://help.vtex.com/en/tutorial/understanding-storebuilder-and-stylesbuilder#structuring-and-configuring-our-store-with-object-object)
The first step to start using this app is to install it in the desired workspace, using:

```sh
vtex install [email protected]
```

This app uses our store builder with the blocks architecture.
To know more about Store Builder [click here.](https://help.vtex.com/en/tutorial/understanding-storebuilder-and-stylesbuilder#structuring-and-configuring-our-store-with-object-object)

To use this app you need to import it in your dependencies on the `manifest.json`.

Expand Down Expand Up @@ -76,6 +83,20 @@ passing them to the `hiddenOptions` prop on the `order-by` component.
}
```

### Plug & Play

For our app to be as _Plug & Play_ as possible it's necessary to follow the good conventions for developing
[`store-themes`](https://github.com/vtex-apps/store-theme) like using open-source components developed by
the [`vtex-apps`](https://github.com/vtex-apps) organization.

Our app is heavily dependent, as seen above, on two major components: [`search-bar`](https://github.com/vtex-apps/store-components/blob/master/docs/SearchBar.md)
and [`search-result`](https://vtex.io/docs/app/vtex.search-result). Our components are developed with the default
implementations in mind, so keep that in mind when using custom components. For custom or closed-source components
to work perfectly with our own, it should resemble both these components as closely as possible.

If you're using any type of custom components on your `store-theme` we can't guarantee the _Plug & Play_
functionality of the components provided by this app.

### Catalog Integration

For this new search experience to work properly a Token and App Key need to be generated and sent
Expand Down

0 comments on commit 1487c63

Please sign in to comment.