kylefang/react-native-code-push
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-code-push.git synced 2026-05-19 19:39:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

further modifications to contributing

Browse Source
This commit is contained in:
scottbommarito
2016-05-27 17:21:47 -07:00
parent 5d2e0cbee5
commit 9905c34beb
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@@ -1,10 +1,10 @@
# Contributing
## Building the plugin
## Using the plugin
### Environment setup
`node.js` and `npm` are needed for building this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: https://nodejs.org/download/.
`node.js` and `npm` are needed for using this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: https://nodejs.org/download/.
Once you have installed `node.js` and `npm`, install the dev dependencies for the project.
@@ -12,9 +12,9 @@ Once you have installed `node.js` and `npm`, install the dev dependencies for th
npm install
```
### Compile
### Using the plugin manually
Follow these steps to build a new version of the plugin:
Follow these steps to test your modifications to the plugin manually:
- clone this repository
- install the dependencies
@@ -22,13 +22,13 @@ Follow these steps to build a new version of the plugin:
```
npm install
```
- compile
- install the plugin in a React-Native project
From the same root folder location, run:
Navigate to the root folder of your React-Native project from your command line console and run:
```
gulp
npm install local_path_to_your_clone_of_this_repo
```
This will compile the sources and place them in the `bin` folder. Any compilation errors will be displayed in the console.
- configure the plugin using the steps in the README.md
## Test