Skip to content

Commit 6f982df

Browse files
committed
Update README.md
1 parent 5ef5662 commit 6f982df

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,18 @@ Create [React](https://github.com/facebook/react) server-side rendering universa
99

1010
You will need [`Node.js`](https://nodejs.org) installed on your system.
1111

12-
### Install
12+
## Quick Start
1313

1414
```bash
15-
npm i @kkt/ssr
15+
npx create-kkt-app my-app
16+
cd my-app
17+
npm start
18+
```
19+
20+
You can also initialize a project from one of the examples. Example from [jaywcjlove/kkt-ssr](./example) example-path.
21+
22+
```bash
23+
npx create-kkt-app my-app -e reach-router-loadable
1624
```
1725

1826
**development**
@@ -58,17 +66,17 @@ module.exports = {
5866

5967
## Example
6068

61-
> A complete [`react + react-router + rematch(redux)`](example/react-router+rematch(redux)) example is recommended for production projects.
69+
> A complete [`react + react-router + rematch(redux)`](example/react-router+rematch) example is recommended for production projects.
6270
6371
- [**`basic`**](example/basic) - Server-side rendering of the [react](https://github.com/facebook/react) base application.
6472
- [**`dynamic-loadable`**](example/dynamic-loadable) - A [react-loadable](https://github.com/jamiebuilds/react-loadable) for server side rendering for your [react](https://github.com/facebook/react) application.
65-
- [**`less`**](example/react-router+rematch(redux)) - React uses the server side rendering of the [Less](https://github.com/less/less.js) based application.
73+
- [**`less`**](example/less) - React uses the server side rendering of the [Less](https://github.com/less/less.js) based application.
6674
- [**`mock-api`**](example/mock-api) - Server-side rendering [mock api](https://github.com/jaywcjlove/webpack-api-mocker) of the React base application.
6775
- [**`reach-router + loadable-components`**](example/reach-router-loadable) - A [reach-router](https://github.com/reach/router) loadable for server side rendering for your react application.
6876
- [**`react-router`**](example/react-router) - React uses server-side rendering of the [react-router](https://github.com/ReactTraining/react-router).
6977
- [**`react-router + loadable-components`**](example/react-router-loadable) - A react-router [loadable-components](https://github.com/smooth-code/loadable-components) for server side rendering.
7078
- [**`react-router + rematch + loadable-component`**](example/react-router-rematch-loadable-component) - A react-router [loadable-components](https://github.com/smooth-code/loadable-components) for server side rendering.
71-
- [**`react-router + rematch(redux)`**](example/react-router+rematch(redux)) - This is a sophisticated example of server-side rendering.
79+
- [**`react-router+rematch`**](example/react-router+rematch) - This is a sophisticated example of server-side rendering.
7280
- [**`scss`**](example/scss) - React uses the server side rendering of the [sass](https://github.com/sass/node-sass) based application.
7381
- [**`styled-components`**](example/styled-components) - Server-side rendering of the react [styled-components](https://github.com/styled-components/styled-components) base application.
7482
- [**`stylus`**](example/stylus) - React uses the server side rendering of the [stylus](https://github.com/stylus/stylus/) based application.

0 commit comments

Comments
 (0)