react-native-os/README.md

43 lines
699 B
Markdown
Raw Normal View History

2016-11-04 23:49:33 +00:00
# os in React Native
node's [os](https://nodejs.org/api/os.html) API in React Native
This module is used by [Peel](http://www.peel.com/)
## Install
* Create a new react-native project. [Check react-native getting started](http://facebook.github.io/react-native/docs/getting-started.html#content)
* In your project dir:
```
npm install --save react-native-os
```
## Link in the native dependency
```
react-native link react-native-os
```
***Step 3 Profit***
## Usage
### package.json
_only if you want to write require('os') in your javascript_
```json
{
"react-native": {
"os": "react-native-os"
}
}
```
## Contributors
[Andy Prock](https://github.com/aprock)
PR's welcome!