Skip to content

Commit fdeb7d7

Browse files
author
soliury
committed
Merge pull request osdio#18 from pupboss/master
Improved Readme
2 parents 05d2f23 + 6a97232 commit fdeb7d7

1 file changed

Lines changed: 20 additions & 30 deletions

File tree

README.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
11
# Noder - A React-Native Client for [cnodejs.org](http://cnodejs.org)
2-
32

43
> A new [cnodejs.org](http://cnodejs.org) mobile app powered by [React-Native](http://facebook.github.io/react-native/) and [Redux](https://github.com/gaearon/redux).
54
65

76
## Develop
87

9-
If you want to run it on you local simulator, you should:
8+
For local development you need to follow the below commands:
109

1110
```
1211
git clone https://github.com/soliury/noder-react-native.git
1312
npm install
1413
react-native bundle
1514
```
16-
Then click run in Xcode, if failed, you should rebuild all package that this project used in Xcode(Just choose the package and **command+B** to run compile)
1715

18-
If you want to run on you local iPhone app, you should follow the [doc](http://facebook.github.io/react-native/docs/runningondevice.html#content).
16+
Click the run button in Xcode, if something went wrong, you need to rebuild all packages that be used in this project with Xcode (Just select the package and press **command+B** to run compile).
17+
18+
If you want to run it on you iPhone, please follow the [Offical Doc](http://facebook.github.io/react-native/docs/runningondevice.html#content).
1919

20-
If you don't want to update the ip by hand, you can use this:
20+
If you don't want to update the ip manually, please run:
2121

2222
```
2323
gulp replace
2424
```
2525

26-
Although, there is a good command, just run:
26+
BTW, here is a prettier command, just run:
2727

2828
```
2929
npm start
3030
```
3131

32-
This will auto replace the ip, and then run the react-native packager.
32+
The ip will be replaced automatically.
3333

3434

35-
## ScreenShots
35+
## Screenshots
3636

3737
![noder](http://7lrzfj.com1.z0.glb.clouddn.com/soliurynoder-v1.0.0.gif)
3838

3939

40-
41-
## React-Native Modules Used
40+
## React-Native Modules In Using
4241

4342
* [react-native-button](https://github.com/ide/react-native-button)
4443
* [react-native-camera](https://github.com/lwansbrough/react-native-camera)
@@ -48,38 +47,29 @@ This will auto replace the ip, and then run the react-native packager.
4847
* [react-native-overlay](https://github.com/brentvatne/react-native-overlay)
4948
* [react-native-scrollable-tab-view](https://github.com/brentvatne/react-native-scrollable-tab-view)
5049

51-
Thanks All above.
50+
This project is heavily influenced by the above modules.
5251

5352
## ToDo List
5453

55-
* Add Push Notification
56-
* Refactor code
57-
* Solve the big bug
58-
* ***In ListView, sometime scroll on the bottom it can't refresh***
54+
* Push Notification
55+
* Refactor the code
56+
* Fix the below bugs
57+
* In ListView, sometime items on the bottom can't be refreshed
5958
* ListView **take too much memory**
60-
* HTML to native View render take too much **memory and time**
61-
* Push to App Store
62-
* Add test
59+
* HTML to native View render take too much **memory and CPU time**
60+
* Submit to App Store
61+
* Add Unit testing
6362

6463
## Change log
6564

66-
See [CHANGELOG]()
65+
Please read [CHANGELOG]()
6766

6867
## Contribute
6968

70-
If you find any bugs, just solve it and submit a PR.
69+
If you find any issues, just solve it and make a PR.
7170

72-
About the code style, Please use the ES6 JSX.
71+
This project is under the ES6 JSX.
7372

7473
## License
7574

7675
[MIT License](http://en.wikipedia.org/wiki/MIT_License)
77-
78-
79-
80-
81-
82-
83-
84-
85-

0 commit comments

Comments
 (0)