Update readme to point to docs

[rcrichton]

Summary by CodeRabbit

• Documentation
  • Added a new section introducing the OpenHIM platform, detailing its purpose and components.
  • Updated the "Tech Used" section to include "Instant OpenHIE."
  • Maintained existing instructions for local and remote setups, CLI usage, and resource allocations.

[coderabbitai]

Walkthrough

The changes in this pull request primarily involve updates to the README.md file. A new section introducing the OpenHIM platform has been added, detailing its purpose, components, and the availability of a CLI tool for deployment and management. Minor formatting adjustments were made, including the addition of "Instant OpenHIE" in the "Tech Used" section. The existing content, including setup instructions and development guidance, remains unchanged.

Changes

File	Change Summary
README.md	- Added new section introducing the OpenHIM platform.
	- Added "Instant OpenHIE" as a bullet point in "Tech Used."
	- Retained existing sections with no content changes.

Poem

In the garden where knowledge grows,
OpenHIM shines, as everyone knows.
With tools for health, so open and bright,
We share and connect, making futures light.
A hop, a skip, through code we glide,
With Instant OpenHIE, come take a ride! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

README.md (1)

3-10: Great introduction section, minor grammar fix needed.

The new OpenHIM platform introduction is well-structured and informative. Consider adding a comma before 'which' in the second bullet point for better readability.

-- The glue that ties these tools together. These are often in the form of OpenHIM mediators which are just microservices that talk to OpenHIM.
++ The glue that ties these tools together. These are often in the form of OpenHIM mediators, which are just microservices that talk to OpenHIM.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~6-~6: Possible missing comma found.
Context: ... These are often in the form of OpenHIM mediators which are just microservices that talk ...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 51e2302 and ba612b7.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~6-~6: Possible missing comma found.
Context: ... These are often in the form of OpenHIM mediators which are just microservices that talk ...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)

README.md (1)

14-14: Verify the tech stack ordering.

The addition of "Instant OpenHIE" is appropriate. Could you confirm if placing it at the top of the list is intentional? Consider if there's a specific ordering principle (e.g., importance, alphabetical) that should be followed.