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

Commit 508567c

Browse files
docs(readme): Update generation lifecycle (#55)
* docs(readme): Update lifecycle * docs(readme): Add React InstantSearch Native to supported templates
1 parent 6502feb commit 508567c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Supported templates are:
6363

6464
- [`InstantSearch.js`][instantsearchjs-github]
6565
- [`React InstantSearch`][react-instantsearch-github]
66+
- [`React InstantSearch Native`][react-instantsearch-github]
6667
- [`Vue InstantSearch`][vue-instantsearch-github]
6768
- [`Angular InstantSearch`][angular-instantsearch-github]
6869

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

114-
### Tasks
115+
### Lifecycle
115116

116117
The app generation follows this lifecycle:
117118

119+
![Lifecycle](https://user-images.githubusercontent.com/6137112/41421858-f838c2a6-6ff7-11e8-8cef-4cc07f1f4f44.png)
120+
121+
<details>
122+
<summary>Alternative text</summary>
123+
118124
1. **Setup**
119125
2. **Build**
120126
3. **Install**
121-
4. (**Clean**) _if the project generation fails_
127+
4. (**Clean**) _if the installation fails_
122128
5. **Teardown**
123129

124-
Each task can be plugged to the third argument of the call `createInstantSearchApp(path, options?, tasks?)`.
130+
</details>
131+
132+
Each task can be plugged to the third argument of `createInstantSearchApp(path, options?, tasks?)` and is passed the configuration of the app.
125133

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

0 commit comments

Comments
 (0)