kloudlite / kl

Kloudlite CLI Client
GNU Affero General Public License v3.0
5 stars 1 forks source link

readme updated #186

Closed nxtcoder36 closed 1 week ago

nxtcoder36 commented 1 week ago

Summary by Sourcery

Update the README to remove outdated sections, simplify commands, and improve clarity by removing Windows installation instructions, the section on exposing ports, and the example list of exposed ports.

Documentation:

sourcery-ai[bot] commented 1 week ago

Reviewer's Guide by Sourcery

This pull request updates the README.md file with several changes to improve clarity and update command syntax. The main changes include commenting out the Windows installation instructions, updating the environment switching command, removing the port exposure section, and simplifying the intercept command.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Comment out Windows installation instructions
  • Convert Windows installation instructions into HTML comments
  • Preserve the original content for potential future use
README.md
Update environment switching command
  • Change command from 'kl env use' to 'kl use env'
README.md
Remove port exposure section
  • Delete the 'Expose Ports' section and its associated command
README.md
Simplify intercept command
  • Update 'kl intercept start -p :' to 'kl intercept'
  • Remove specific port mapping from the command
README.md
Remove ports section from configuration
  • Delete the 'ports' section from the configuration example
README.md

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).