diff --git a/README.md b/README.md index b7891c3..718d34d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,47 @@ +
+

+

+ + MiBridge + +
+ MiSpeed +

+

Powerful yet simple to use .

+

+

+ + GNU/Linux Build Status + + + Windows Build Status + + MacOS Build Status + + + Nightly Build + +
+

+
+ + # MiSpeed ## Other language versions [简体中文](./README_zh.md) + +## Index + +- [Our Purpose](#our-purpose) +- [Introduction](#introduction) +- [Our Advantages](#our-advantages) +- [Access Note](#access-note) + - [Applying for debugging permission](#applying-for-debugging-permission) + - [APIs](#apis) + - [Applying for fromal permission](#applying-for-fromal-permission) + - [More cooperation](#more-cooperation) + ## Our Purpose All for users, make users getting the best experience! ## Introduction @@ -21,7 +61,7 @@ which can improve the performance of developers in key application scenarios and   Inclued:
  *mibridge*: Source code of MiBridge.jar
  *app*: Testing application code.
-#### 1. Applying for debugging permission
+#### Applying for debugging permission
Please provide the following information and send it to xiaomi-mispeed-support@xiaomi.com to apply for debugging permission.
Subject:xx Company,Applying for MiSpeed debugging permission。
@@ -38,7 +78,7 @@ Note: What is VAID, how to get it? [__Support Devices__](./support_devices.md) -#### 2. APIs +#### APIs __Permission apis__
1. ```boolean checkDebugPermission(Context context, String pkg, int uid, String auth_key)```
@@ -126,7 +166,7 @@ __APIs for request system resouce__
-1: Fail
-2: Permission not granted!
-

3. Applying for fromal permission

+#### Applying for fromal permission Please provide the following information and send it to xiaomi-mispeed-support@xiaomi.com to apply for formal permission.
Subject:xx Company,Applying for MiSpeed formal permission。
__`Note:To apply for formal permission,relevant business agreements need to be signed.`__
@@ -160,7 +200,7 @@ Scenario 2 | .. | .. | .. Note:We will also do power consumption test according to the scenarios provided by you.
-#### 4. More cooperation +#### More cooperation More APIs will be supported in the future
requestGpuHighFreq,requestIOHighFreq,requestMemory,requestNetwork and so on. diff --git a/README_zh.md b/README_zh.md index 3f7842a..36be29f 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,7 +1,50 @@ +
+

+

+ + MiBridge + +
+ MiSpeed +

+

Powerful yet simple to use .

+

+

+ + Build Status + + + Doc Status + + Jar Status + + + license + +
+

+
+ + # 小米应用加速器 ## 其他语言 [English](./README.md) + +## Index + +- [我们的目的](#我们的目的) +- [简介](#简介) +- [我们的优势](#我们的优势) +- [接入说明](#接入说明) + - [申请调试权限](#申请调试权限) + - [接口定义](#接口定义) + - [申请正式权限](#申请正式权限) + - [更多合作](#更多合作) + + + + ## 我们的目的 一切为了用户,让用户得到最好的体验! ## 简介 @@ -20,7 +63,7 @@  此目录包含:
  *mibridge*: MiBridge jar包的实现代码。
  *app*: 测试MiBridge的app代码。
-#### 1. 申请调试权限
+#### 申请调试权限 请提供以下信息,发送到邮箱xiaomi-mispeed-support@xiaomi.com, 申请接入调试权限。
#### 邮件主题:xx(APP名称)申请小米应用加速器接入调试权限
@@ -32,7 +75,7 @@ com.mi.testmibridge | 张三 | [__支持设备版本列表__](./support_devices.md) -#### 2. 接口定义 +#### 接口定义 __权限检查接口__
1. ```boolean checkPermission(String pkg, int uid)```
@@ -178,7 +221,7 @@ __系统资源申请接口__
-1: Fail
-2: Permission not granted!
-

3. 申请正式权限

+#### 申请正式权限 请提供以下信息,发送到邮箱xiaomi-mispeed-support@xiaomi.com, 申请正式权限。
邮件主题:xx(APP名称)申请小米应用加速器正式权限
__1. 资源接口使用场景
@@ -211,7 +254,7 @@ __3. 功耗测试
备注:我们也会根据您提供的场景进行功耗测试。
-#### 4. 更多合作 +#### 更多合作 后续将会开放更多接口
requestIOHighFreq,requestMemory,requestNetwork等 diff --git a/data/MiSpeed-1.0.0.svg b/data/MiSpeed-1.0.0.svg new file mode 100644 index 0000000..dbd5d06 --- /dev/null +++ b/data/MiSpeed-1.0.0.svg @@ -0,0 +1 @@ +MiSpeed: 1.0.0MiSpeed1.0.0 \ No newline at end of file diff --git a/data/docs-1.0.0-blue.svg b/data/docs-1.0.0-blue.svg new file mode 100644 index 0000000..105e04e --- /dev/null +++ b/data/docs-1.0.0-blue.svg @@ -0,0 +1 @@ +docs: 1.0.0docs1.0.0 \ No newline at end of file diff --git a/data/img b/data/img new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/data/img @@ -0,0 +1 @@ + diff --git a/data/jar-available-blueviolet.svg b/data/jar-available-blueviolet.svg new file mode 100644 index 0000000..034b080 --- /dev/null +++ b/data/jar-available-blueviolet.svg @@ -0,0 +1 @@ +jar: availablejaravailable \ No newline at end of file diff --git a/data/license-Apache2.0-brightgreen.svg b/data/license-Apache2.0-brightgreen.svg new file mode 100644 index 0000000..81fe830 --- /dev/null +++ b/data/license-Apache2.0-brightgreen.svg @@ -0,0 +1 @@ +license: Apache2.0licenseApache2.0 \ No newline at end of file diff --git a/data/xiaomi_circle.png b/data/xiaomi_circle.png new file mode 100644 index 0000000..903b31f Binary files /dev/null and b/data/xiaomi_circle.png differ diff --git a/data/xiaomi_circle.svg b/data/xiaomi_circle.svg new file mode 100644 index 0000000..3a6a43d --- /dev/null +++ b/data/xiaomi_circle.svg @@ -0,0 +1 @@ +