Skip to content

Commit 2434ccd

Browse files
docs(all):
1 parent f9b979e commit 2434ccd

File tree

26 files changed

+1448
-1265
lines changed

26 files changed

+1448
-1265
lines changed

docs/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Includes:
1212
* SSR support
1313
* bunch of drop-in modules which handle common scenarios
1414
* React utilities (`stapp-react` and `stapp-react-hooks`)
15-
* CLI helpers
15+
* CLI helpers (`stapp-cli-tools`)
1616

1717
### Table of contents
1818

@@ -33,11 +33,15 @@ Includes:
3333
## Installation
3434

3535
```bash
36-
npm install stapp
37-
# or
38-
yarn add stapp
36+
npm install stapp redux rxjs
37+
# OR using stapp-cli-tools
38+
stapp install stapp
3939
```
4040

41+
### Peer dependencies
42+
* **rxjs**: >= 6
43+
* **redux**: >= 4
44+
4145
## Motivation
4246

4347
Here are some obvious statements:

docs/guides/cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1111

1212
`stapp-cli-tools` can be used to install and update stapp packages and theirs peer dependencies.
13+
Also, we definitely plan to implement various code generation features.
1314

1415
## Installation and usage
1516
```text

docs/guides/react.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ type RenderProps<S, A = {}, State = S> = {
3131
}
3232
```
3333
34+
### Installation
35+
```bash
36+
npm install stapp-react stapp stapp-formbase react rxjs
37+
# OR using stapp-cli-tools
38+
stapp install stapp-react
39+
```
40+
41+
#### Peer dependencies
42+
* **stapp**: >= 2.6
43+
* **stapp-formbase**: >= 2.6
44+
* **react**: >= 16
45+
* **rxjs**: >= 6
46+
47+
3448
### Binded components
3549
* `createConsumer`: creates a Consumer component
3650
* `createConsume`: old-school higher order component
@@ -344,6 +358,19 @@ const App = () => <Provider app={counterApp}>
344358
render(App, rootNode)
345359
```
346360
361+
### Installation
362+
```bash
363+
npm install stapp-react-hooks stapp react stapp-formbase
364+
# OR using stapp-cli-tools
365+
stapp install stapp-cli-tools
366+
```
367+
368+
#### Peer dependencies
369+
* **react**: >= 16.8
370+
* **stapp**: >= 2.6
371+
* **stapp-formbase**: >= 2.6
372+
373+
347374
### `useStapp()`
348375
Returns a tuple of a state, an application API and an application itself.
349376
Accepts an optional selector, which will be applied to an application state.

docs/modules/formbase.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,17 @@
1414

1515
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1616

17+
## Installation
18+
```bash
19+
npm install stapp-formbase stapp reselect
20+
# OR using stapp-cli-tools
21+
stapp install stapp-formbase
22+
```
23+
24+
### Peer dependencies
25+
* **stapp**: >= 2.6
26+
* **reselect**: >= 4
27+
1728
## Definition
1829

1930
```typescript

docs/modules/loaders.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@
1111

1212
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1313

14+
## Installation
15+
```bash
16+
npm install stapp-loaders stapp reselect
17+
# OR using stapp-cli-tools
18+
stapp install stapp-loaders
19+
```
20+
21+
### Peer dependencies
22+
* **stapp**: >= 2.6
23+
* **reselect**: >= 4
24+
1425
## Definition
1526

1627
```typescript

docs/modules/persist.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@
1616

1717
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1818

19+
## Installation
20+
```bash
21+
npm install stapp-persist stapp rxjs
22+
# OR using stapp-cli-tools
23+
stapp install stapp-persist
24+
```
25+
26+
### Peer dependencies
27+
* **stapp**: >= 2.6
28+
* **rxjs**: >= 6
29+
1930
## Definition
2031

2132
```typescript

docs/modules/select.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ stores the result at the provided field `name` in the app state and dispatches `
1515

1616
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1717

18+
## Installation
19+
```bash
20+
npm install stapp-select stapp rxjs
21+
# OR using stapp-cli-tools
22+
stapp install stapp-select
23+
```
24+
25+
### Peer dependencies
26+
* **stapp**: >= 2.6
27+
* **rxjs**: >= 6
28+
1829
## Definition
1930

2031
```typescript

docs/modules/validate.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ Debouncing, throttling and other time-controlling mechanisms are up to you.
1515

1616
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1717

18+
## Installation
19+
```bash
20+
npm install stapp-`validate` stapp stapp-formbase rxjs reselect
21+
# OR using stapp-cli-tools
22+
stapp install stapp-validate
23+
```
24+
25+
### Peer dependencies
26+
* **stapp**: >= 2.6
27+
* **stapp-formbase**: >= 2.6
28+
* **reselect**: >= 4
29+
* **rxjs**: >= 6
30+
1831
## Definition
1932

2033
```typescript

packages/stapp-formbase/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,15 @@ See [documentation](https://stapp.js.org/modules/formbase.html) for more info.
66

77
## Installation
88
```bash
9-
npm install stapp-formbase
9+
npm install stapp-formbase stapp reselect
10+
# OR using stapp-cli-tools
11+
stapp install stapp-formbase
1012
```
1113

14+
### Peer dependencies
15+
* **stapp**: >= 2.6
16+
* **reselect**: >= 4
17+
1218
## License
1319

1420
```

packages/stapp-formbase/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
},
3939
"peerDependencies": {
4040
"reselect": ">=4",
41-
"stapp": ">=2.5"
41+
"stapp": ">=2.6"
4242
},
4343
"devDependencies": {
4444
"@types/jest": "^24.0.6",

0 commit comments

Comments
 (0)