This PR updates the README.md file with detailed information about the project, including its purpose, usage examples, and guidelines for contributing.
Summary of Changes
Added a detailed project description at the beginning of the README.md file.
Included usage examples in the README.md file, referencing the code in the Message.java and MessageDecoder.java files.
Added a 'Contributing' section to the README.md file, providing instructions for contributing to the project.
Added a 'License' section to the README.md file, including a brief description and a link to the full license text in the LICENSE file.
Please review and merge these changes to provide better documentation for the project.
Fixes #1.
🎉 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 (click)
Description
This PR updates the README.md file with detailed information about the project, including its purpose, usage examples, and guidelines for contributing.
Summary of Changes
Please review and merge these changes to provide better documentation for the project.
Fixes #1.
🎉 Latest improvements to Sweep:
💡 To get Sweep to edit this pull request, you can: