This PR updates the README.md file with comprehensive information about the project, including a detailed project description, usage instructions, contribution guidelines, and license details.
Summary of Changes
Added a detailed project description at the beginning of the README.md file.
Added a 'Usage' section with examples of how to use the library, using information from the MessageDecoder.java and Message.java files.
Added a 'Contribution' section explaining how others can contribute to the project.
Added a 'License' section with a brief explanation of the license (Apache 2.0) and a link to the full license in the LICENSE file.
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 comprehensive information about the project, including a detailed project description, usage instructions, contribution guidelines, and license details.
Summary of Changes
Fixes #1.
🎉 Latest improvements to Sweep:
💡 To get Sweep to edit this pull request, you can: