search

elixir-cloud-aai / crate-db

Microservice for handling RO-Crates
Apache License 2.0
1 stars 0 forks source link

docs: add initial README.md #30

Closed Rahuljagwani closed 4 months ago

Rahuljagwani commented 5 months ago

Fixes #31

Summary by Sourcery

Initialized the README.md file to provide detailed documentation about the ELIXIR Crate DB project, including its objectives, architecture, and future development plans.

sourcery-ai[bot] commented 5 months ago

Reviewer's Guide by Sourcery

This pull request adds a new README.md file that provides a detailed overview of the ELIXIR Crate DB project. It includes sections on the project's purpose, user story, goals, implementation details, technologies used, challenges, and future development plans. The README.md serves as a foundational document to guide contributors and users through the project's objectives and technical aspects.

File-Level Changes

Files Changes
README.md Initial creation of README.md with comprehensive project details, including introduction, user story, goals, implementation details, technical challenges, and future prospects.
Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
uniqueg commented 5 months ago

Solves #31

Summary by Sourcery

Initialized the README.md file to provide detailed documentation about the ELIXIR Crate DB project, including its objectives, architecture, and future development plans.

  • Documentation:

    • Added a comprehensive README.md file outlining the project's purpose, user story, goals, implementation details, architecture, technologies, challenges, and future prospects.

Note the accepted keywords to link PRs to issues: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests

Solves is not one of them.