Skip to content
This repository was archived by the owner on Dec 16, 2022. It is now read-only.

docs(readme): Update generation lifecycle #55

Merged
merged 2 commits into from
Jun 15, 2018
Merged

docs(readme): Update generation lifecycle #55

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22cc2bb
docs(readme): Update lifecycle
francoischalifour Jun 14, 2018
7f20c81
docs(readme): Add React InstantSearch Native to supported templates
francoischalifour Jun 14, 2018
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
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Supported templates are:

- [`InstantSearch.js`][instantsearchjs-github]
- [`React InstantSearch`][react-instantsearch-github]
- [`React InstantSearch Native`][react-instantsearch-github]
- [`Vue InstantSearch`][vue-instantsearch-github]
- [`Angular InstantSearch`][angular-instantsearch-github]

Expand Down Expand Up @@ -111,17 +112,24 @@ const app = createInstantSearchApp('~/lab/my-app', {
app.create().then(() => console.log('App generated!'));
```

### Tasks
### Lifecycle

The app generation follows this lifecycle:

![Lifecycle](https://user-images.githubusercontent.com/6137112/41421858-f838c2a6-6ff7-11e8-8cef-4cc07f1f4f44.png)

<details>
<summary>Alternative text</summary>

1. **Setup**
2. **Build**
3. **Install**
4. (**Clean**) _if the project generation fails_
4. (**Clean**) _if the installation fails_
5. **Teardown**

Each task can be plugged to the third argument of the call `createInstantSearchApp(path, options?, tasks?)`.
</details>

Each task can be plugged to the third argument of `createInstantSearchApp(path, options?, tasks?)` and is passed the configuration of the app.

<h6 align="center">Tasks example</h6>

Expand Down