Fix README grammar, terminology, and clarity#41
Merged
Conversation
Agent-Logs-Url: https://github.com/esrrhs/spp/sessions/9c8adda5-88d1-4524-877c-91ced98a65ca Co-authored-by: esrrhs <4083816+esrrhs@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
esrrhs
April 10, 2026 11:36
View session
esrrhs
approved these changes
Apr 10, 2026
There was a problem hiding this comment.
Pull request overview
This PR improves the project’s README by correcting machine-translated grammar and standardizing terminology (e.g., “proxy/protocol” instead of “agent/agreement”), with clearer usage and performance-testing descriptions.
Changes:
- Standardizes README terminology around “protocols” and “proxy” across the Features/Instructions sections.
- Rewrites several instruction bullets for clearer, more grammatical descriptions (including
-proxyprotowording). - Rewords Performance Testing scenario descriptions to be more concise/scannable.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ``` | ||
| * Internal communication between Client and Server, can also be modified to other protocols, automatic conversion between external protocols and internal protocols. E.g | ||
| * Internal communication between Client and Server can also use other protocols; automatic conversion between external protocols and internal protocols is supported. E.g |
| * Test the maximum bandwidth speed in the case where the IPERF script using the Benchmark / local_tcp directory is tested in the CPU. The proxy protocol is TCP, and the results of various transit protocols are used as follows: | ||
| * Using the IPERF script in the Benchmark/local_tcp directory, tested on a single machine (CPU-bound), the maximum bandwidth with TCP as the proxy protocol and various transit protocols is as follows: | ||
|
|
||
| | Agent | Speed | Speed (Ency) | Speed (Encryption Compression) |
| * Using the IPERF script of the Benchmark / Remote_TCP directory, in the multi-machine test, the server is located in Tencent Cloud, the client is located locally, and the maximum bandwidth speed is tested. The proxy protocol is TCP, and the results of various transit protocols are used as follows: | ||
| * Using the IPERF script in the Benchmark/remote_tcp directory, tested across multiple machines (server on Tencent Cloud, client local), the maximum bandwidth with TCP as the proxy protocol and various transit protocols is as follows: | ||
|
|
||
| | Agent | Speed | Speed (Ency) | Speed (Encryption Compression) |
|
|
||
| # Performance Testing | ||
| * Test the maximum bandwidth speed in the case where the IPERF script using the Benchmark / local_tcp directory is tested in the CPU. The proxy protocol is TCP, and the results of various transit protocols are used as follows: | ||
| * Using the IPERF script in the Benchmark/local_tcp directory, tested on a single machine (CPU-bound), the maximum bandwidth with TCP as the proxy protocol and various transit protocols is as follows: |
| | quic forwarding | 35.5 MBytes/sec | 32.8 MBytes/sec|15.1 MBytes/sec | | ||
|
|
||
| * Using the IPERF script of the Benchmark / Remote_TCP directory, in the multi-machine test, the server is located in Tencent Cloud, the client is located locally, and the maximum bandwidth speed is tested. The proxy protocol is TCP, and the results of various transit protocols are used as follows: | ||
| * Using the IPERF script in the Benchmark/remote_tcp directory, tested across multiple machines (server on Tencent Cloud, client local), the maximum bandwidth with TCP as the proxy protocol and various transit protocols is as follows: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README contained multiple issues stemming from machine translation: inconsistent terminology (agent/agreement vs. proxy/protocol), grammatical errors, and confusing run-on descriptions in the Performance Testing section.
Changes
-proxyprotoparameter reference casing