This PR adds the installation process documentation to the README.md file. It addresses the issue #6 by providing clear and concise instructions on how to install and use the project.
Summary of Changes
Added a new section titled "Installation Process" to the README.md file.
Included step-by-step instructions on how to clone the repository and set up the necessary environment variables (OPENAI_API_KEY and GITHUB_TOKEN).
Added a new section titled "Usage" to the README.md file.
Provided examples of how to run the project and what to expect as output.
Updated the "Setup workflow in 2 steps" section to include the new installation process and usage instructions.
Please review and merge this PR to ensure that users have clear instructions on how to install and use the project.
Fixes #6.
š Latest improvements to Sweep:
Getting Sweep to run linters before committing! Check out Sweep Sandbox Configs to set it up.
Added support for self-hosting! Check out Self-hosting Sweep to get started.
[Self Hosting] Multiple options to compute vector embeddings, configure your .env file using VECTOR_EMBEDDING_SOURCE
š” To get Sweep to edit this pull request, you can:
Leave a comment below to get Sweep to edit the entire PR
Leave a comment in the code will only modify the file
Edit the original issue to get Sweep to recreate the PR from scratch
PR Feedback: š
Description
This PR adds the installation process documentation to the README.md file. It addresses the issue #6 by providing clear and concise instructions on how to install and use the project.
Summary of Changes
Please review and merge this PR to ensure that users have clear instructions on how to install and use the project.
Fixes #6.
š Latest improvements to Sweep:
š” To get Sweep to edit this pull request, you can: