Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vrnobody authored Jan 9, 2025
1 parent b436f01 commit 850453b
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/obfus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ jobs:
`${{ env.projName }}.zip` 是 `${{ env.TAG }}` 混淆后的代码
SHA256: ${{ env.CHECKSUM }}
Action ID: [${{ github.run_id }}](${{ env.actionRunsUrl }}${{ github.run_id }})
`Source code (zip)` 里面有明文代码
更新日志:[update-log.md](https://github.com/vrnobody/cfxhttp/blob/main/docs/update-log.md)
这个发布使用 [attestations](https://docs.github.com/zh/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds) 来保证,混淆后的代码没有夹带私货。
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
1. 在 workers 的配置页面添加路由,指向上面新加的二级域名,例如: `sub-domain.your-website.com/*`
1. 在设置面板中添加环境变量: `UUID``XHTTP_PATH`

访问 `https://sub-domain.your-website.com/(XHTTP_PATH)/?fragment=true&uuid=(UUID)` 获取 xhttp 协议的客户端 `config.json`
访问 `https://sub-domain.your-website.com/(XHTTP_PATH)/?fragment=true&uuid=(UUID)`
获取 xhttp 协议的客户端 `config.json`
*xhttp 协议只能部署到 workers,不能部署到 pages 详见 [issue #2](https://github.com/vrnobody/cfxhttp/issues/2)*

#### 各设置项说明
Expand All @@ -42,7 +43,7 @@
* `TIME_ZONE` 日志时间戳的时区,中国填 `8`

#### 注意事项
* src/index.js 是开发中的代码会有 bug,请到 releases 里面下载 Source code (zip)
* src/index.js 是开发中的代码,会有 bug,请到 [releases](https://github.com/vrnobody/cfxhttp/releases) 里面下载 Source code (zip)
* 网站测速结果是错的,这个脚本很慢,不要有太高的期望
* workers / pages 不支持 UDP,需要 UDP 功能的应用无法使用,例如:DNS
* workers / pages 有 CPU 时间限制,需要长时间链接的应用会随机断线,例如:下载大文件
Expand Down
2 changes: 1 addition & 1 deletion docs/en.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Visit `https://sub-domain.your-website.com/(XHTTP_PATH)/?fragment=true&uuid=(UUI
* `TIME_ZONE` Timestamp time zone of logs. e.g. Argentina is `-3`

#### Notice
* `src/index.js` is under developing, could have bugs, please download `Source code (zip)` from releases.
* `src/index.js` is under developing, could have bugs, please download `Source code (zip)` from [releases](https://github.com/vrnobody/cfxhttp/releases).
* This script is slow, do not expect too much.
* Workers and pages do not support UDP. Applications require UDP feature will not work. Such as DNS.
* Workers and pages have CPU executing-time limit. Applications require long-term connection would disconnect randomly. Such as downloading a big file.
Expand Down
2 changes: 1 addition & 1 deletion test/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ test('pick_random_proxy', () => {
expect(index.pick_random_proxy('')).toBe('')
expect(index.pick_random_proxy('a.com')).toBe('a.com')

// one line test
// single line test
let ps = ' , p.a.com p.b.com,p.c.com, , , , , p.d.com, ,,,, '
let r = []
for (let i = 0; i < 100; i++) {
Expand Down

0 comments on commit 850453b

Please sign in to comment.