Skip to content

Commit 9817084

Browse files
committed
update readme
1 parent f49250d commit 9817084

File tree

4 files changed

+50
-12
lines changed

4 files changed

+50
-12
lines changed

README.en.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,44 @@
11
# GitHubPopular
22
This is a GitHub most popular repositories viewer with React Native.
3-
## DownLoad APP
4-
Android:
5-
[GitHubPopular-release-v1.0.0.apk](https://raw.githubusercontent.com/crazycodeboy/GitHubPopular/master/resource/apk/GitHubPopular-release-v1.0.0.apk)
6-
![GitHubPopular-release-v1.0.0-Android](./resource/apk/GitHubPopular-release-v1.0.0-Android.png)
7-
## How does it look like?
8-
iOS:
9-
![GitHubPopular Preview-iOS](./resource/screenshot/GitHubPopular Preview-iOS.gif)
10-
Android:
11-
![GitHubPopular Preview-Android](./resource/screenshot/GitHubPopular Preview-Android.gif)
12-
## How to run
3+
4+
## Contents
5+
6+
* [Features](#features)
7+
* [DownLoad](#downLoad)
8+
* [Screenshot](#screenshot)
9+
* [Running and debugging](#running-and-debugging)
10+
* [ToDo](#todo)
11+
12+
## Features
13+
14+
* Supports subscription to more than 50 programming languages;
15+
* Support for adding / deleting programming languages and support for customizing their sorting;
16+
* Support favorite projects;
17+
* Support multiple color themes to switch freely;
18+
* Support search, and self-sustaining custom subscription keywords;
19+
* Support to share, easy to share their favorite projects to friends;
20+
21+
22+
## DownLoad
23+
24+
![DownLoad](https://raw.githubusercontent.com/crazycodeboy/crazycodeboy.github.io/master/io/GitHubPopular/img/baidushoujizhushou.png)[Go to download](http://sj.qq.com/myapp/detail.htm?apkName=com.jph.githubpopular)
25+
![DownLoad](https://raw.githubusercontent.com/crazycodeboy/crazycodeboy.github.io/master/io/GitHubPopular/img/yingyingbao.png)[Go to download](http://shouji.baidu.com/software/10123273.html)
26+
27+
28+
## Running and debugging
1329

1430
1. Prepare your environment: [Requirements](http://facebook.github.io/react-native/docs/getting-started.html#requirements)
1531
2. Clone [GitHubPopular](https://github.com/crazycodeboy/GitHubPopular.git), and goto the project root directory.
1632
3. run `npm i`.
1733
4. run `react-native run-ios` or `react-native run-android`.
1834
5. Yeah. You make it.
35+
36+
## ToDo
37+
38+
**V2.0 planning**
39+
40+
- [ ] Sliding hide NavBar
41+
- [ ] Text support large, medium and small
42+
- [ ] Support night mode
43+
- [ ] Use Redux
44+
- [ ] i18 internationalization

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22

33
这是一个用来查看GitHub最受欢迎与最热项目的App,它基于React Native支持Android和iOS双平台。
44

5+
[English](./README.en.md)
6+
57
## 目录
68

79
* [功能与特性](#功能与特性)
810
* [下载安装](#下载安装)
911
* [预览图](#预览图)
12+
* [运行调试](#运行调试)
1013
* [ToDo](#todo)
1114

1215
## 功能与特性
@@ -32,15 +35,24 @@
3235

3336
![GitHub Popular](./resource/screenshot/GitHubPopular-3.jpg)
3437

38+
# 运行调试
39+
40+
1. 准备React Native环境,可参考: [Requirements](https://facebook.github.io/react-native/docs/getting-started.html#requirements)
41+
2. Clone [GitHubPopular](https://github.com/crazycodeboy/GitHubPopular.git),然后终端进入项目根目录。
42+
3. 终端运行 `npm i`
43+
4. 然后运行 `react-native run-ios``react-native run-android`
44+
5. Ok,有问题可以提[issues](https://github.com/crazycodeboy/GitHubPopular/issues)出来
45+
46+
3547
## ToDo
3648

3749
**V2.0规划**
3850

39-
- [ ] 上滑动自动隐藏NavBar
51+
- [ ] 上滑自动隐藏NavBar
4052
- [ ] 文字支持大、中、小
4153
- [ ] 夜间模式
4254
- [ ] 使用Redux
43-
- [ ] i18国际化国际化
55+
- [ ] i18国际化
4456

4557

4658

-6.56 KB
Binary file not shown.
-7.3 MB
Binary file not shown.

0 commit comments

Comments
 (0)