Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.md #30

Merged
merged 16 commits into from
Sep 3, 2024
Merged

docs: update README.md #30

merged 16 commits into from
Sep 3, 2024

Conversation

athith-g
Copy link
Collaborator

@athith-g athith-g commented Sep 2, 2024

Updates readme provide a full picture of the middleware.

Summary by Sourcery

Update the README to provide a detailed explanation of the middleware's functionality, implementation, and security considerations, along with updated installation and testing instructions.

Documentation:

  • Expand the README to provide a comprehensive overview of the middleware, including its purpose, implementation details, and important considerations for use.
  • Add sections on middleware functionality, decryption process, and security considerations, emphasizing the need for a Trusted Execution Environment.
  • Include installation instructions using Poetry and update testing requirements and instructions.
  • Enhance the contributing section with guidelines and a code of conduct link.

@athith-g athith-g marked this pull request as ready for review September 2, 2024 01:12
Copy link

sourcery-ai bot commented Sep 2, 2024

Reviewer's Guide by Sourcery

This pull request updates the README.md file to provide a more comprehensive overview of the middleware, including implementation details, important considerations, and visual aids. The changes focus on improving the documentation and clarity of the project.

File-Level Changes

Change Details Files
Expanded project description and implementation details
  • Added a more detailed description of the middleware's purpose
  • Included information about the decryption executor and volume
  • Added explanations of how the middleware alters TES requests
  • Included a section on the decryption process
README.md
Added visual aids to explain the middleware's functionality
  • Included a request diagram to illustrate how the middleware modifies TES requests
  • Added a workflow diagram to show the decryption process
README.md
Updated installation and testing instructions
  • Changed installation instructions to use Poetry
  • Updated testing requirements and instructions
  • Removed outdated prerequisites section
README.md
Added important considerations for usage
  • Included a warning about using the middleware in untrusted environments
  • Mentioned the need for a Trusted Execution Environment (TEE)
README.md
Updated project metadata and links
  • Added contributing guidelines and code of conduct links
  • Included logos for GA4GH, ELIXIR, and ELIXIR Cloud & AAI
  • Updated and added new reference links
README.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @athith-g - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@uniqueg uniqueg changed the title docs: Update readme docs: update readme Sep 2, 2024
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor typos/issues - otherwise this is an absolutely exemplary doc page!!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@uniqueg uniqueg changed the title docs: update readme docs: update README.md Sep 3, 2024
@uniqueg uniqueg merged commit 42a5093 into main Sep 3, 2024
1 check passed
@uniqueg uniqueg deleted the update_readme branch September 3, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants