Skip to content

Commit eb2bd8c

Browse files
committed
Add a small Getting Started section
1 parent 1178ce3 commit eb2bd8c

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@ Build OS X desktop apps using React Native.
66
[![npm version](https://badge.fury.io/js/react-native-desktop.svg)](https://badge.fury.io/js/react-native-desktop)
77
[![discord #react-native-desktop](https://img.shields.io/badge/discord-%23react--native--desktop-blue.svg)](https://discordapp.com/channels/102860784329052160/111514927801307136)
88

9-
[![Youtube play](https://cloud.githubusercontent.com/assets/1004115/11681502/1eeb716e-9e81-11e5-9359-d4ce61a965d1.png)](https://www.youtube.com/watch?v=m1-LNKIuqtI)
9+
[![Youtube play](https://cloud.githubusercontent.com/assets/1004115/11685246/75db9d6a-9e99-11e5-8378-1d5cea6053c0.png)](https://www.youtube.com/watch?v=m1-LNKIuqtI)
1010

11-
**It's not production ready**: the lack of few important APIs, documentation, benchmarks and completed examples (work in progress).
11+
**It's not a production-ready yet**
1212

13-
**Getting started**
13+
## Getting started
1414

15-
Since it's simply a fork of React Native, you can follow the same steps to run Examples. Feel free to ask anything on `#react-native-desktop` channel if you run into problems (and you probably will).
15+
```
16+
npm install react-native-desktop-cli -g
17+
cd projects
18+
react-native-desktop init MyProject
19+
```
20+
Since it's simply a fork of React Native, basically you just can follow [the same steps](http://facebook.github.io/react-native/docs/getting-started.html#content).
21+
Feel free to ask anything on `#react-native-desktop` channel if you run into problems (and you probably will).
1622

1723
****
1824

local-cli/generator/templates/index.osx.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ var <%= name %> = React.createClass({
1717
return (
1818
<View style={styles.container}>
1919
<Text style={styles.welcome}>
20-
Welcome to React Native!
20+
Welcome to React Native Desktop!
2121
</Text>
2222
<Text style={styles.instructions}>
23-
To get started, edit index.ios.js
23+
To get started, edit index.osx.js
2424
</Text>
2525
<Text style={styles.instructions}>
2626
Press Cmd+R to reload,{'\n'}
27-
Cmd+D or shake for dev menu
27+
Cmd+D for dev menu
2828
</Text>
2929
</View>
3030
);

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-native-desktop",
3-
"version": "0.1.13",
4-
"description": "A framework for building desktop native apps using React",
3+
"version": "0.2.0",
4+
"description": "A framework for building native desktop apps using React",
55
"license": "BSD-3-Clause",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)