Skip to content

Commit

Permalink
Merge pull request #3 from zh0903/master
Browse files Browse the repository at this point in the history
Embellish the README file.
ZiqiangGe-xiaomi authored Jan 13, 2022
2 parents 487ef62 + 2e985ec commit 1b3b3e3
Showing 9 changed files with 97 additions and 8 deletions.
48 changes: 44 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,47 @@
<div align="center">
<p>
<h1>
<a href="https://github.com/MiCode/MiBridge">
<img src="data/xiaomi_circle.svg" alt="MiBridge" />
</a>
<br />
MiSpeed
</h1>
<h4>Powerful yet simple to use .</h4>
</p>
<p>
<a >
<img src="data/MiSpeed-1.0.0.svg" alt="GNU/Linux Build Status" />
</a>
<a >
<img src="data/docs-1.0.0-blue.svg" alt="Windows Build Status" />
</a>
<img src="data/jar-available-blueviolet.svg" alt="MacOS Build Status" />
</a>
<a >
<img src="data/license-Apache2.0-brightgreen.svg" alt="Nightly Build" />
</a>
<br>
</p>
</div>


# 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
&emsp; Inclued: <br>
&emsp;&emsp;*mibridge*: Source code of MiBridge.jar<br>
&emsp;&emsp;*app*: Testing application code.<br>
#### 1. Applying for debugging permission<br>
#### Applying for debugging permission<br>
Please provide the following information and send it to xiaomi-mispeed-support@xiaomi.com to apply for debugging permission.<br>
Subject:xx Company,Applying for MiSpeed debugging permission。<br>

@@ -38,7 +78,7 @@ Note: What is VAID, how to get it?

[__Support Devices__](./support_devices.md)

#### 2. APIs
#### APIs
__Permission apis__<br>

1. ```boolean checkDebugPermission(Context context, String pkg, int uid, String auth_key)```<br>
@@ -126,7 +166,7 @@ __APIs for request system resouce__<br>
-1: Fail<br>
-2: Permission not granted!<br>

<h4 id="formal">3. Applying for fromal permission</h4>
#### Applying for fromal permission
Please provide the following information and send it to xiaomi-mispeed-support@xiaomi.com to apply for formal permission.<br>
Subject:xx Company,Applying for MiSpeed formal permission。<br>
__`Note:To apply for formal permission,relevant business agreements need to be signed.`__<br>
@@ -160,7 +200,7 @@ Scenario 2 | .. | .. | ..
Note:We will also do power consumption test according to the scenarios provided by you.<br>


#### 4. More cooperation
#### More cooperation
More APIs will be supported in the future<br>
requestGpuHighFreq,requestIOHighFreq,requestMemory,requestNetwork and so on.

51 changes: 47 additions & 4 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,50 @@
<div align="center">
<p>
<h1>
<a href="https://github.com/MiCode/MiBridge">
<img src="data/xiaomi_circle.svg" alt="MiBridge" />
</a>
<br />
MiSpeed
</h1>
<h4>Powerful yet simple to use .</h4>
</p>
<p>
<a >
<img src="data/MiSpeed-1.0.0.svg" alt="Build Status" />
</a>
<a >
<img src="data/docs-1.0.0-blue.svg" alt="Doc Status" />
</a>
<img src="data/jar-available-blueviolet.svg" alt="Jar Status" />
</a>
<a >
<img src="data/license-Apache2.0-brightgreen.svg" alt="license" />
</a>
<br>
</p>
</div>


# 小米应用加速器
## 其他语言
[English](./README.md)


## Index

- [我们的目的](#我们的目的)
- [简介](#简介)
- [我们的优势](#我们的优势)
- [接入说明](#接入说明)
- [申请调试权限](#申请调试权限)
- [接口定义](#接口定义)
- [申请正式权限](#申请正式权限)
- [更多合作](#更多合作)




## 我们的目的
一切为了用户,让用户得到最好的体验!
## 简介
@@ -20,7 +63,7 @@
&emsp;此目录包含: <br>
&emsp;&emsp;*mibridge*: MiBridge jar包的实现代码。<br>
&emsp;&emsp;*app*: 测试MiBridge的app代码。<br>
#### 1. 申请调试权限<br>
#### 申请调试权限
请提供以下信息,发送到邮箱xiaomi-mispeed-support@xiaomi.com, 申请接入调试权限。<br>
#### 邮件主题:xx(APP名称)申请小米应用加速器接入调试权限<br>

@@ -32,7 +75,7 @@ com.mi.testmibridge | 张三 |

[__支持设备版本列表__](./support_devices.md)

#### 2. 接口定义
#### 接口定义
__权限检查接口__<br>

1. ```boolean checkPermission(String pkg, int uid)```<br>
@@ -178,7 +221,7 @@ __系统资源申请接口__<br>
-1: Fail<br>
-2: Permission not granted!<br>

<h4 id="formal">3. 申请正式权限</h4>
#### 申请正式权限
请提供以下信息,发送到邮箱xiaomi-mispeed-support@xiaomi.com, 申请正式权限。<br>
邮件主题:xx(APP名称)申请小米应用加速器正式权限<br>
__1. 资源接口使用场景<br>
@@ -211,7 +254,7 @@ __3. 功耗测试<br>
备注:我们也会根据您提供的场景进行功耗测试。<br>


#### 4. 更多合作
#### 更多合作
后续将会开放更多接口<br>
requestIOHighFreq,requestMemory,requestNetwork等

1 change: 1 addition & 0 deletions data/MiSpeed-1.0.0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions data/docs-1.0.0-blue.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions data/img
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions data/jar-available-blueviolet.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions data/license-Apache2.0-brightgreen.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added data/xiaomi_circle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions data/xiaomi_circle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1b3b3e3

Please sign in to comment.