Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gigantz committed Feb 8, 2021
1 parent 13b67d9 commit 2e41ef4
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 42 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ const Updates = () => (
);

ReactXpress.render(<ExpressApp />);

```

### How to use
Expand All @@ -76,13 +75,16 @@ ReactXpress.render(<ExpressApp />);

### Components

`<app />` - App Instance (props: port)
<br/>
`<static />` - Static route (props: publicPath, path, options)
<br/>
`<router />` - Router-Provider (props: path)
<br/>
`<get />, <post /> and ...` - Route component (props: path, content, handler, status)
`<App />` - App Instance (props: port)
`<Static />` - Static route (props: publicPath, path, options)
`<Router />` - Router-Provider (props: path)
`<Get />, <Post /> and ...` - Route component (props: path, content, handler, status)
`<Res />` - Response components
`<Res.Render />` - Render (props: component)
`<Res.Content />` - Response send (props: json, text, contentType)
`<Res.Status />` - Response Status (props: statusCode)
`<Res.SendFile />` - Response Send File (props: path, options, onError)
`<Res.Redirect />` - Redirect (props: path, statusCode)
<br />
<br />

Expand Down
63 changes: 29 additions & 34 deletions src/pages/ComponentsPage.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,40 +10,35 @@ export const ComponentsPage = () => (
</Helmet>
<Wrapper>
<p>
<p>
<span>{`<App />`}</span> - App Instance (props: port)
</p>
<p>
<span>{`<Static />`}</span> - Static route (props: publicPath, path, options)
</p>
<p>
<span>{`<Router />`}</span> - Router-Provider (props: path)
</p>
<p>
<span>{`<Get />, <Post /> and ...`}</span> - Route component (props: path, content,
handler, status)
</p>
<p>
<span>{`<Res />`}</span> - Response components
</p>
<p>
<span>{`<Res />`}</span> - Response components
</p>
<p>
<span>{'- <Res.Render />'}</span> - Render (props: component){' '}
</p>
<p>
<span>{'- <Res.Content />'}</span> - Render (props: json, text, contentType){' '}
</p>
<p>
<span>{'- <Res.Status />'}</span> - Render (props: statusCode){' '}
</p>
<p>
<span>{'- <Res.Redirect />'}</span> - Render (props: path, statusCode){' '}
</p>
<p>
<span>{'- <Res.SendFile />'}</span> - Render (props: path, options, onError){' '}
</p>
<span>{`<App />`}</span> - App Instance (props: port)
</p>
<p>
<span>{`<Static />`}</span> - Static route (props: publicPath, path, options)
</p>
<p>
<span>{`<Router />`}</span> - Router-Provider (props: path)
</p>
<p>
<span>{`<Get />, <Post /> and ...`}</span> - Route component (props: path, content, handler,
status)
</p>
<p>
<span>{`<Res />`}</span> - Response components
</p>
<p>
<span>{`<Res.Render />`}</span> - Render (props: component)
</p>
<p>
<span>{`<Res.Content />`}</span> - Response send (props: json, text, contentType)
</p>
<p>
<span>{`<Res.Status />`}</span> - Response Status (props: statusCode)
</p>
<p>
<span>{`<Res.SendFile />`}</span> - Response Send File (props: path, options, onError)
</p>
<p>
<span>{`<Res.Redirect />`}</span> - Redirect (props: path, statusCode)
</p>
<br />
<code>Sorry for this, better page is in process...</code>
Expand Down

0 comments on commit 2e41ef4

Please sign in to comment.