chore: optimize README in English #99
Conversation
WalkthroughThe changes in Changes
Poem
Tip AI model upgrade
|
|
commit: egg-security
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (7 hunks)
Additional context used
LanguageTool
README.md
[style] ~504-~504: ‘by mistake’ might be wordy. Consider a shorter alternative.
Context: ... E.g.: taketext/plainastext/htmlby mistake and render it, especially when there's ...(EN_WORDINESS_PREMIUM_BY_MISTAKE)
Additional comments not posted (12)
README.md (12)
42-42: Improvement in clarity and grammar.The sentence has been improved for clarity and grammatical correctness:
- Before:
If you want to disable some security precautions, setenableporperty to 'false' directly.- After:
To disable some security precautions, setenableproperty to 'false' directly.This change enhances readability and correctness.
99-99: Correction in grammar and punctuation.The sentence has been corrected for grammar and punctuation:
- Before:
Then we can configurectx.securityOptions[name] optsin the custom middleware or controller,then the current request configuration will overrides the default configuration (new configuration will be merged and override the default project configuration, but only take effect in the current request)- After:
Then we can configurectx.securityOptions[name] optsin the custom middleware or controller, then the current request configuration will override the default configuration (new configuration will be merged and override the default project configuration, but only take effect in the current request)This change improves readability and correctness.
115-115: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
Not all security plugins support dynamic configuration, only following plugins list support- After:
Not all security plugins support dynamic configuration, only the following plugins list supportThis change improves readability and correctness.
394-394: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
So please check the applicable scenarios forshtml, it usually used for richtext submmited by user.- After:
So please check the applicable scenarios forshtml, it is usually used for rich-text submitted by user.This change improves readability and correctness.
396-396: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
A usage error will limit functions, also affect the performance of the server.- After:
A usage error will limit functions, and also affect the performance of the server.This change improves readability and correctness.
483-483: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
Refer to [lusca](https://github.com/krakenjs/lusca), appriciate for their works.- After:
Refer to [lusca](https://github.com/krakenjs/lusca), appreciate their work.This change improves readability and correctness.
494-494: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
Default disabled. If you need to enable it, please contact your security engineers and determine the opening strategy- After:
Default disabled. If you need to enable it, please contact your security engineers and determine the opening strategy.This change improves readability and correctness.
500-500: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
Default enabled, disable IE download dialog automatically open download file and will cause XSS- After:
Default enabled, disable IE download dialog automatically opens download file and will cause XSSThis change improves readability and correctness.
504-504: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
Disable IE8's auto MIME sniffing. E.g.: taketext/plainastext/htmlby mistake and render it, especially when there's something untrusted in the local service.- After:
Disable IE8's auto MIME sniffing. E.g.: taketext/plainastext/htmlincorrectly and render it, especially when there's something untrusted in the local service.This change improves readability and correctness.
Tools
LanguageTool
[style] ~504-~504: ‘by mistake’ might be wordy. Consider a shorter alternative.
Context: ... E.g.: taketext/plainastext/htmlby mistake and render it, especially when there's ...(EN_WORDINESS_PREMIUM_BY_MISTAKE)
508-508: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
Defaulting to "SAMEORIGIN", only allow iframe embed by same origin.- After:
Defaulting to "SAMEORIGIN", only allows iframe to embed by the same origin.This change improves readability and correctness.
514-514: Correction in grammar and clarity.The sentence has been corrected for grammar and clarity:
- Before:
- disable Defaulting tofalse，same as1; mode=block.- After:
- disable Defaulting tofalse, the same as1; mode=block.This change improves readability and correctness.
524-525: Correction in grammar and clarity.The sentences have been corrected for grammar and clarity:
Before:
- ipBlackList(Array) - specific which ip are illegal when request withsafeCurl.After:
- ipBlackList(Array) - specific which IP addresses are illegal when requested withsafeCurl.Before:
- ipExceptionList(Array) - specific which ip are legal within ipBlackList.After:
- ipExceptionList(Array) - specific which IP addresses are legal within ipBlackList.These changes improve readability and correctness.
请原谅我改一些明显的语法错误😀
Summary by CodeRabbit