Skip to content

docs(readme): add Getting Started section#118

Merged
feloy merged 1 commit intokortex-hub:mainfrom
bmahabirbu:docs/add-getting-started-readme
Mar 27, 2026
Merged

docs(readme): add Getting Started section#118
feloy merged 1 commit intokortex-hub:mainfrom
bmahabirbu:docs/add-getting-started-readme

Conversation

@bmahabirbu
Copy link
Copy Markdown
Contributor

Summary

  • Adds a "Getting Started" section to the README with prerequisites, build, run, install, and test instructions
  • Placed between the Introduction and Glossary sections for easy discoverability

Test plan

  • Verify make build command works as documented
  • Verify make test command works as documented
  • Review README renders correctly on GitHub

🤖 Generated with Claude Code

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Warning

Rate limit exceeded

@feloy has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 13 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 14 minutes and 13 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 40190a0e-5cf9-4a69-820f-b5c7bafb4273

📥 Commits

Reviewing files that changed from the base of the PR and between 7029441 and fa2128b.

📒 Files selected for processing (1)
  • README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bmahabirbu bmahabirbu force-pushed the docs/add-getting-started-readme branch from 424e93e to dd49d35 Compare March 27, 2026 06:43
@bmahabirbu
Copy link
Copy Markdown
Contributor Author

Just thought for any new go users this might be helpful!

Copy link
Copy Markdown
Contributor

@feloy feloy left a comment

Choose a reason for hiding this comment

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

thanks, LGTM

…ions

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Brian <bmahabir@bu.edu>
@feloy feloy force-pushed the docs/add-getting-started-readme branch from dd49d35 to fa2128b Compare March 27, 2026 08:17
@feloy feloy merged commit ab7f5f2 into kortex-hub:main Mar 27, 2026
6 checks passed
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.

3 participants