Adding params to readme

[amitschendel]

Type

Documentation

---

Description

This PR focuses on enhancing the project's documentation. It adds a detailed description of the parameters to the README file, providing users with better understanding and usage guidance.

---

PR changes walkthrough

	Relevant files
Documentation	1 files README.md                                                                                                      README.md The changes in the README file include the addition of a detailed description of the parameters.

[codiumai-pr-agent-free[bot]]

PR Description updated to latest commit (https://github.com/armosec/kubecop/commit/0232b3f7a286956f1cabb3b88aad37ae4a67d52a)

[codiumai-pr-agent-free[bot]]

PR Analysis

• 🎯 Main theme: Enhancing project documentation

• 📝 PR summary: This PR aims to improve the project's documentation by adding a detailed description of the parameters to the README file. This will provide users with a better understanding and guidance on how to use the project.

• 📌 Type of PR: Documentation

• 🧪 Relevant tests added: Not applicable

• ⏱️ Estimated effort to review [1-5]: 1, because it's a documentation update with no code changes.

• 🔒 Security concerns: No

  PR Feedback

• 💡 General suggestions: The PR seems to be well-structured and focused on enhancing the documentation. It's always good to see efforts to make the project more user-friendly by providing detailed instructions and descriptions. Keep up the good work!

• 🤖 Code feedback:

How to use

Instructions

> To invoke the PR-Agent, add a comment using one of the following commands: > **/review**: Request a review of your Pull Request. > **/describe**: Update the PR title and description based on the contents of the PR. > **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > **/ask \**: Ask a question about the PR. > **/update_changelog**: Update the changelog based on the PR's contents. > **/add_docs**: Generate docstring for new components introduced in the PR. > **/generate_labels**: Generate labels for the PR based on the PR's contents. > see the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To edit any configuration parameter from the [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml), add --config_path=new_value. >For example: /review --pr_reviewer.extra_instructions="focus on the file: ..." >To list the possible configuration parameters, add a **/config** comment.