docs: add usage section to README - #11
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
👀 AI Code Review
This PR introduces a 'Usage' section to the README, which is a fantastic addition! Clear documentation is essential for helping users adopt the plugin effectively and get started quickly. The example you provided is straightforward and shows users exactly how to incorporate the plugin into their configuration, which is very helpful. I appreciate the effort to enhance user experience through improved documentation.
However, while the usage addition is great, it might be beneficial to include a brief explanation of what this plugin does and why users would want to utilize it in their projects. This context can help users understand its value and motivate them to implement it properly. What do you think about adding a short introductory line or two before getting into the JSON snippet?
Powered by GPT-4o via GitHub Models
| @@ -80,3 +80,11 @@ All tests are in `src/__tests__/`. Run `npm run test:watch` during development. | |||
| - **Not a sandbox**: Focused on chain-splitting with path awareness, not comprehensive shell obfuscation detection. For full isolation, pair with a sandbox solution. | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
This usage section is a great addition! Would it be helpful to add a brief description of what the plugin does before jumping into the example?
|
|
||
|
|
||
|
|
||
| ## Usage |
There was a problem hiding this comment.
The JSON snippet looks good. If you could provide an example of what the complete opencode.json file might look like with this plugin included, it could help new users even more!
👀 AI Code ReviewLooks good to me. Powered by GPT-4o via GitHub Models |
1 participant
Adding a usage example section to help users get started quickly.