Skip to content

Commit

Permalink
Merge pull request ptmt#140 from andrerfneves/master
Browse files Browse the repository at this point in the history
README Updates to improve clarity
  • Loading branch information
ptmt authored Feb 4, 2017
2 parents a2eaeeb + ab6ce90 commit bc703d7
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
## React Native for macOS (ex react-native-desktop)

Build macOS desktop apps using React Native and Cocoa.
# React Native macOS (ex react-native-desktop)
Build macOS desktop applications using React Native and Cocoa.

[![Build Status](https://travis-ci.org/ptmt/react-native-macos.svg)](https://travis-ci.org/ptmt/react-native-macos)
[![npm version](https://badge.fury.io/js/react-native-macos.svg)](https://badge.fury.io/js/react-native-macos)
Expand All @@ -12,34 +11,40 @@ Build macOS desktop apps using React Native and Cocoa.
</View>
```

## Getting started

## Getting Started
Node 4.x+, OS X 10.10+ required.

*Previous React Native experience is highly recommended*.

``` bash
$ npm install react-native-macos-cli -g
$ react-native-macos init MyProject
$ cd MyProject
$ open macos/MyProject.xcodeproj
```
Since it's simply just a fork, you can follow [the same instruction on facebook.github.io/react-native](http://facebook.github.io/react-native/docs/getting-started.html#content).

**Disclaimer**. Having previous experience with React Native highly recommended. There is no success story for any RN for macOS app yet, so it's not proven by production use.
## Documentation
Since React Native macOS is just a fork, you can follow [the same instructions on the React Native Documentation](http://facebook.github.io/react-native/docs/getting-started.html#content).

Feel free to ask anything on `#react-native-platforms` channel if you run into problems.
## Disclaimer
React Native macOS is a fork of React Native for iOS. The library is still fairly new so proceed at your own risk. There has been no successful story for any React Native macOS application yet, so it's not proven by production use.

## Community Help
Feel free to ask anything on `#react-native-platforms` channel on Reactiflux if you happen to run into problems.

## Examples
### UIExplorer
UIExplorer includes a set of component examples that illustrate their functionality. It also allows you to load external JavaScript bundle files through HTTP. Simply copy and paste a URL into the Search Field.

[Download UIExplorer](https://github.com/ptmt/react-native-macos/files/199128/UIExplorer.zip)

UIExplorer includes a set of examples and allows to you load external javascript bundle by http. Just copy&paste URL into SearchField.


![screenshot 2016-03-31 21 06 33](https://cloud.githubusercontent.com/assets/1004115/14185918/91648d8c-f784-11e5-82b6-fcd08b74b89a.png)

![screenshot 2016-03-31 21 00 30](https://cloud.githubusercontent.com/assets/1004115/14185806/1cd2dfdc-f784-11e5-8c14-de0ca21f7ead.png)

<img width="986" alt="screenshot 2015-10-24 16 40 36" src="https://cloud.githubusercontent.com/assets/1004115/14185895/7c133eb0-f784-11e5-8e3c-ca36aa351a26.png">

## Video Demo
Running a simple Chat app in React Native macOS.

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

0 comments on commit bc703d7

Please sign in to comment.