Documentation for GPT Feature

[vsingk]

General:

While using CLI Surf, I decided to use my own API key instead of relying on gpt4free and felt that there could be additional documentation added for, especially if gpt4free goes under after being sued.

• [ ✓ ] Have you followed the guidelines in our Contributing document?
• [ ✓ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Code:

1. [✓ ] Have you added an explanation of what your changes do?

Summary by Sourcery

Document the process for using OpenAI's GPT models in cli-surf to generate personalized surf reports, providing guidance on obtaining an API key, configuring the environment, and customizing the GPT prompt.

Documentation:

• Add documentation for enabling GPT Surf Reports using OpenAI's GPT models, including steps to obtain an API key, update the .env file, and use the GPT argument.
• Include customization options for the GPT prompt and notes on usage, such as API costs, response time, and model selection.

[sourcery-ai[bot]]

Reviewer's Guide by Sourcery

This pull request adds comprehensive documentation for the GPT feature in the CLI Surf project. The changes are made to the README.md file, providing users with detailed instructions on how to enable and use GPT-generated surf reports.

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

File-Level Changes

Change	Details	Files
Added documentation for GPT-generated surf reports	Introduced a new section '🧠 GPT Surf Report' Provided step-by-step instructions for obtaining an OpenAI API key Explained how to update the .env file with necessary GPT configurations Demonstrated usage of the GPT argument in CLI commands Included examples for customizing the GPT prompt Added notes on common issues, API costs, response time, and model selection	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. #### 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).

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

[ryansurf]

The gpt definitely needed more documentation, thanks for detailing its usage. Looks great. I was a little worried about the long-term usage of gpt4free, haha

Merging now 👍

[ryansurf]

@all-contributors please add @vsingk for documentation

[allcontributors[bot]]

@ryansurf

I've put up a pull request to add @vsingk! :tada: