Skip to content

Commit

Permalink
Merge pull request #4 from streamich/ci-circleci
Browse files Browse the repository at this point in the history
docs: ✏️ improve router docs
  • Loading branch information
streamich committed Jun 9, 2018
2 parents 35f863a + bdca678 commit 628b140
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ cache:
notifications:
email: false
node_js:
- '9'
- '8'
script:
- npm run test
Expand All @@ -17,6 +16,8 @@ matrix:
allow_failures: []
fast_finish: true
after_success:
- npx ci-scripts github-post
- npx ci-scripts slack
- npm run semantic-release
branches:
except:
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,17 @@ const MyComponent = mock();
- [`<Img>`](./docs/en/Img.md)
- [`<WidthQuery>`](./docs/en/WidthQuery.md), [`<View>`](./docs/en/View.md), [`<WindowWidthQuery>`](./docs/en/WindowWidthQuery.md), and [`<InlineWidthQuery>`](./docs/en/InlineWidthQuery.md)
- [`<Audio>`](./docs/en/Audio.md) and [`<Video>`](./docs/en/Video.md)
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md), `<Prompt>`, `<Confirm>`
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md)
- [Animation](./docs/en/Animation.md)
- [`<AfterTimeout>`](./docs/en/AfterTimeout.md), [`<AfterDraf>`](./docs/en/AfterDraf.md), and [`<WhenIdle>`](./docs/en/WhenIdle.md)
- [`<Render>`](./docs/en/Render.md), [`withRender()`](./docs/en/Render.md#withrender-hoc), and [`@withRender`](./docs/en/Render.md#withrender-decorator)
- [`<RenderInterval>`](./docs/en/RenderInterval.md), [`withRenderInterval()`](./docs/en/RenderInterval.md#withrenderinterval-hoc), and [`@withRenderInterval`](./docs/en/RenderInterval.md#withrenderinterval-decorator)
- [`<Tween>`](./docs/en/Tween.md), [`withTween()`](./docs/en/Tween.md#withtween-hoc), and [`@withTween`](./docs/en/Tween.md#withtween-decorator)
- [`<Interpolation>`](./docs/en/Interpolation.md), [`withInterpolation()`](./docs/en/Interpolation.md#withinterpolation-hoc), and [`@withInterpolation`](./docs/en/Interpolation.md#withinterpolation-decorator)
- [Side Effects](./docs/en/Side-effects.md)
- [`<LocalStorage>`](./docs/en/LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
- [`<LocalStorage>`](./docs/en/LocalStorage.md)
- [`<ClassNames>`](./docs/en/ClassNames.md)
- `<Title>`, `<Favicon>`
- [`go()`](./docs/en/routing.md#go), [`<Sms>`](./docs/en/Sms.md), [`<Mailto>`](./docs/en/Mailto.md), and `<Tel>`
- [`go()`](./docs/en/routing.md#go), [`<Sms>`](./docs/en/Sms.md), [`<Mailto>`](./docs/en/Mailto.md)
- [Boundaries](./docs/en/Boundaries.md)
- [`<BrowserOnly>`](./docs/en/BrowserOnly.md), [`<ServerOnly>`](./docs/en/ServerOnly.md), and [`<ElectronOnly>`](./docs/en/ElectronOnly.md)
- [`<ErrorBoundary>`](./docs/en/ErrorBoundary.md) and [`withErrorBoundary()`](./docs/en/ErrorBoundary.md#witherrorboundary-hoc)
Expand Down
6 changes: 3 additions & 3 deletions docs/en/routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Reference:
- [`createRouter()`](#createrouter)


## Use any state container
###### Use any state container

With libreact's `<Router>` you can choose to store the current route in your state continer (like Redux or MobX) of
choice.
Expand Down Expand Up @@ -58,7 +58,7 @@ so, simply use:
```


## Multiple routers
###### Multiple routers

You can have many routers operating on the same page in parallel. All you have to do is specify a *namespace* using the `ns` prop.

Expand All @@ -68,7 +68,7 @@ You can have many routers operating on the same page in parallel. All you have t
</Router>
```

You can have *app-inside-app* that has its own routing logic.
Or use [`createRouter()`](#createrouter) to create React components with bound namespace.


## Reference
Expand Down
17 changes: 16 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,29 @@
"ts-node": "4.1.0",
"typescript": "2.6.2",
"webpack": "3.10.0",
"semantic-release": "^12.2.4",
"semantic-release": "^15.5.0",
"@semantic-release/changelog": "^2.0.2",
"@semantic-release/npm": "^3.3.1",
"@semantic-release/git": "^5.0.0",
"gitbook-cli": "2.3.2",
"glob": "^7.1.2",
"mkdirp": "0.5.1",
"react": "^16.2.0",
"react-dom": "^16.2.0",
"prop-types": "^15.6.0"
},
"release": {
"verifyConditions": [
"@semantic-release/changelog",
"@semantic-release/npm",
"@semantic-release/git"
],
"prepare": [
"@semantic-release/changelog",
"@semantic-release/npm",
"@semantic-release/git"
]
},
"config": {
"commitizen": {
"path": "git-cz"
Expand Down

0 comments on commit 628b140

Please sign in to comment.