chore(docs): update readme to use banner rather than logo #106
Conversation
|
Warning Rate Limit Exceeded@madflojo has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 35 minutes and 5 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. WalkthroughThe recent update involves a visual enhancement to the documentation by replacing the tarmac logo with a more prominent tarmac banner image. This change aims to improve the aesthetic appeal and clarity of the README. Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (2)
docs/README.md (2)
Line range hint
13-13: Correct the spelling to include a hyphen: "language-agnostic".- Tarmac is language agnostic and offers built-in support for key/value stores like BoltDB, Redis, and Cassandra... + Tarmac is language-agnostic and offers built-in support for key/value stores like BoltDB, Redis, and Cassandra...
Line range hint
79-94: Standardize the use of dollar signs in command examples.Consider removing the dollar signs before commands in the example sections to maintain consistency and avoid confusion when copying and pasting commands.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
docs/tarmac-banner.pngis excluded by!**/*.png
Files selected for processing (1)
- docs/README.md (1 hunks)
Additional Context Used
LanguageTool (1)
docs/README.md (1)
Near line 13: This expression is ususally spelled with a hyphen
Context: ...ch to application frameworks. Tarmac is language agnostic and offers built-in support for key/val...
Rule ID: SPECIFIC_HYPHEN
Markdownlint (35)
docs/README.md (35)
27: Column: 1
Hard tabs
28: Column: 1
Hard tabs
34: Column: 1
Hard tabs
36: Column: 1
Hard tabs
37: Column: 1
Hard tabs
38: Column: 1
Hard tabs
39: Column: 1
Hard tabs
40: Column: 1
Hard tabs
46: Column: 1
Hard tabs
48: Column: 1
Hard tabs
49: Column: 1
Hard tabs
51: Column: 1
Hard tabs
52: Column: 1
Hard tabs
53: Column: 1
Hard tabs
54: Column: 1
Hard tabs
55: Column: 1
Hard tabs
56: Column: 1
Hard tabs
57: Column: 1
Hard tabs
58: Column: 1
Hard tabs
59: Column: 1
Hard tabs
60: Column: 1
Hard tabs
61: Column: 1
Hard tabs
63: Column: 1
Hard tabs
64: Column: 1
Hard tabs
65: Column: 1
Hard tabs
66: Column: 1
Hard tabs
67: Column: 1
Hard tabs
68: Column: 1
Hard tabs
69: Column: 1
Hard tabs
71: Column: 1
Hard tabs
72: Column: 1
Hard tabs
79: null
Dollar signs used before commands without showing output
80: null
Dollar signs used before commands without showing output
94: null
Dollar signs used before commands without showing output
3: null
Images should have alternate text (alt text)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
The way the logo renders doesn't sit right with me, I think it would be better to use the full banner.
Summary by CodeRabbit