Skip to content

Commit 0a4101b

Browse files
authored
chore: remove maintenance docs and trim README (#20)
Delete the docs/maintenance/ tree (internal notes that do not belong in the repo). Trim the README to English only: keep the research-purpose disclaimer sentence and the Google Play warning, refresh the supported proxy protocols (native Mieru / Hysteria2 Gecko / MasterDnsVPN) and subscription formats, and remove the changelog/telegram, homepage, and donation sections. Credits and contributors are kept.
1 parent 6b3caba commit 0a4101b

6 files changed

Lines changed: 11 additions & 604 deletions

File tree

README.md

Lines changed: 11 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,18 @@
11
# NekoBox for Android
22

33
[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21)
4-
[![Releases](https://img.shields.io/github/v/release/MatsuriDayo/NekoBoxForAndroid)](https://github.com/MatsuriDayo/NekoBoxForAndroid/releases)
54
[![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-orange.svg)](https://www.gnu.org/licenses/gpl-3.0)
6-
[![Contributors](https://img.shields.io/github/contributors/starifly/NekoBoxForAndroid)](https://github.com/starifly/NekoBoxForAndroid/graphs/contributors)
75

8-
## 免责声明
6+
## Disclaimer
97

10-
> 免责声明:本项目仅用于技术研究与代码学习之目的,不提供任何形式的网络代理服务。请勿将本项目用于违反当地法律法规的任何活动。请勿在生产环境中使用本项目,使用者应自行承担使用本项目可能带来的全部风险。若您下载或引用本项目,请在 24 小时内自行删除相关内容,并避免长期存储、分享或传播本项目的任何部分。**作者保留随时修改、更新或移除本项目及其内容的权利,恕不另行通知。**
11-
>
12-
> Disclaimer: This project is intended solely for technical research and code learning purposes and does not provide any form of network proxy service. Please do not use this project for any activities that violate local laws and regulations. Do not use this project in production environments. Users are fully responsible for any risks that may arise from using this project. If you download or reference this project, please delete all related content within 24 hours and avoid long-term storage, distribution, or dissemination of any part of this project. **The author reserves the right to modify, update, or remove any part of this project or its contents at any time without prior notice.**
8+
> This project is intended solely for technical research and code learning purposes and does not provide any form of network proxy service.
139
14-
## 下载 / Downloads
15-
16-
[![GitHub All Releases](https://img.shields.io/github/downloads/Matsuridayo/NekoBoxForAndroid/total?label=downloads-total&logo=github&style=flat-square)](https://github.com/starifly/NekoBoxForAndroid/releases)
17-
18-
[GitHub Releases 下载](https://github.com/starifly/NekoBoxForAndroid/releases)
19-
20-
**Google Play 版本自 2024 年 5 月起已被第三方控制,为非开源版本,请不要下载。**
10+
## Downloads
2111

2212
**The Google Play version has been controlled by a third party since May 2024 and is a non-open
2313
source version. Please do not download it.**
2414

25-
## 更新日志 & Telegram 发布频道 / Changelog & Telegram Channel
26-
27-
https://t.me/Matsuridayo
28-
29-
## 项目主页 & 文档 / Homepage & Documents
30-
31-
https://matsuridayo.github.io
32-
33-
## 支持的代理协议 / Supported Proxy Protocols
15+
## Supported Proxy Protocols
3416

3517
* SOCKS (4/4a/5)
3618
* HTTP(S)
@@ -45,14 +27,15 @@ https://matsuridayo.github.io
4527
* ShadowTLS
4628
* TUIC
4729
* Juicity
48-
* Hysteria 1/2
30+
* Hysteria 1/2 (including Gecko obfuscation, bundled)
4931
* WireGuard
32+
* MasterDnsVPN (DNS-tunnel, bundled)
33+
* Mieru (bundled)
5034
* Trojan-Go (trojan-go-plugin)
5135
* NaïveProxy (naive-plugin)
52-
* Mieru (mieru-plugin)
5336

5437
<details>
55-
<summary>XHTTP Extra TLS配置示例</summary>
38+
<summary>XHTTP Extra TLS configuration example</summary>
5639

5740
<pre><code class="language-json">
5841
{
@@ -127,7 +110,7 @@ https://matsuridayo.github.io
127110
</details>
128111

129112
<details>
130-
<summary>XHTTP Extra Reality配置示例</summary>
113+
<summary>XHTTP Extra Reality configuration example</summary>
131114

132115
<pre><code class="language-json">
133116
{
@@ -205,42 +188,15 @@ https://matsuridayo.github.io
205188
</code></pre>
206189
</details>
207190

208-
请到[这里](https://matsuridayo.github.io/nb4a-plugin/)下载插件以获得完整的代理支持.
209-
210-
Please visit [here](https://matsuridayo.github.io/nb4a-plugin/) to download plugins for full proxy
211-
supports.
212-
213-
## 支持的订阅格式 / Supported Subscription Format
214-
215-
* 一些广泛使用的格式 (如 Shadowsocks, ClashMeta 和 v2rayN)
216-
* sing-box 出站
191+
Trojan-Go and NaïveProxy require their external plugins for full proxy support.
217192

218-
仅支持解析出站,即节点。分流规则等信息会被忽略。
193+
## Supported Subscription Format
219194

220195
* Some widely used formats (like Shadowsocks, ClashMeta and v2rayN)
221196
* sing-box outbound
222197

223198
Only resolving outbound, i.e. nodes, is supported. Information such as diversion rules are ignored.
224199

225-
## 捐助 / Donate
226-
227-
<details>
228-
229-
如果这个项目对您有帮助, 可以通过捐赠的方式帮助我们维持这个项目.
230-
231-
捐赠满等额 50 USD 可以在「[捐赠榜](https://mtrdnt.pages.dev/donation_list)」显示头像, 如果您未被添加到这里,
232-
欢迎联系我们补充.
233-
234-
Donations of 50 USD or more can display your avatar on
235-
the [Donation List](https://mtrdnt.pages.dev/donation_list). If you are not added here, please
236-
contact us to add it.
237-
238-
USDT TRC20
239-
240-
`TFVcx36pVLuCWLbWiMdT5KP2PsfQ2SJVEZ`
241-
242-
</details>
243-
244200
## Credits
245201

246202
Core:

docs/maintenance/dependency-audit.md

Lines changed: 0 additions & 210 deletions
This file was deleted.

0 commit comments

Comments
 (0)