Skip to content

Commit e62af07

Browse files
committed
Add quickstart to readme and /docs link to site
1 parent 360e116 commit e62af07

File tree

3 files changed

+51
-7
lines changed

3 files changed

+51
-7
lines changed

README.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
1-
ReactJS.NET
1+
[ReactJS.NET](http://reactjs.net/)
22
===========
33
ReactJS.NET is a library that makes it easier to use Facebook's
44
[React](http://facebook.github.io/react/) and
5-
[JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) from C#. To get
6-
started, [take a look at the documentation](http://reactjs.net/getting-started/getting-started.html).
7-
8-
**It is currently under development and there is no stable release at the moment.
9-
Coming soon!**
5+
[JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) from C#.
106

117
Features
128
========
@@ -18,6 +14,36 @@ Features
1814
* [Server-side component rendering](http://reactjs.net/guides/server-side-rendering.html)
1915
to make your initial render super-fast (experimental!)
2016

17+
Quick Start
18+
===========
19+
Install the package
20+
```
21+
Install-Package React.Mvc4
22+
```
23+
24+
Create JSX files
25+
```javascript
26+
// /Scripts/HelloWorld.jsx
27+
/** @jsx React.DOM */
28+
var HelloWorld = React.createClass({
29+
render: function () {
30+
return (
31+
<div>Hello {this.props.name}</div>
32+
);
33+
}
34+
});
35+
```
36+
37+
Reference the JSX files from your HTML
38+
```html
39+
<script src="@Url.Content("~/Scripts/HelloWorld.jsx")"></script>
40+
```
41+
42+
Now you can use the `HelloWorld` component.
43+
44+
For information on more advanced topics (including precompilation and
45+
server-side rendering), check out [the documentation](http://reactjs.net/docs)
46+
2147
Licence
2248
=======
2349
BSD License for ReactJS.NET

site/nginx.conf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ server {
55

66
# Shortcuts
77
rewrite ^/download$ /getting-started/download.html redirect;
8+
rewrite ^/docs$ /getting-started/download.html redirect;
89

910
rewrite ^/packages/$ /packages/index.php;
1011
rewrite ^/packages/\$metadata$ /packages/metadata.xml;

site/public/index.htm

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,28 @@
1313
font-size: 4em;
1414
margin: 0;
1515
}
16+
h2 {
17+
margin: 0;
18+
padding: 0;
19+
}
20+
a, a:visited {
21+
color: yellow;
22+
text-decoration: none;
23+
}
24+
a:hover {
25+
text-decoration: underline;
26+
}
1627
</style>
1728
</head>
1829
<body>
1930
<img src="http://facebook.github.io/react/img/logo_og.png" alt="React logo" width="300" height="300" />
2031
<h1>ReactJS.NET</h1>
21-
<p>Coming soon!</p>
32+
<h2>Use React and JSX from C# / .NET</h2>
33+
<p>
34+
<a href="/docs">Docs</a> &middot;
35+
<a href="/download">Download</a> &middot;
36+
<a href="http://github.com/ReactJS/React.NET">GitHub</a>
37+
</p>
38+
<p>Site coming soon!</p>
2239
</body>
2340
</html>

0 commit comments

Comments
 (0)