Skip to content

Updating Docs with new logo and better architecture diagram #58

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

Merged
merged 1 commit into from
Sep 24, 2023

Conversation

madflojo
Copy link
Member

@madflojo madflojo commented Sep 24, 2023

Summary by CodeRabbit

  • New Feature: Added support for "In-Memory" and "BoltDB" as datastores in Tarmac. The "In-Memory" option is ideal for testing, development, and non-persistent caching, while the "BoltDB" option ensures strong consistency and persistent storage.
  • Documentation: Updated the project's README to provide a clearer description of Tarmac's purpose, emphasizing its language-agnostic nature and support for key/value stores and databases. Also added a table listing supported languages and their capabilities.
  • Documentation: Enhanced the "Running Tarmac" guide with a new section on configuring and using BoltDB as a datastore.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 24, 2023

Walkthrough

This update enhances Tarmac's documentation, providing a clearer project overview and introducing new datastore options: "In-Memory" for testing and development, and "BoltDB" for persistent storage with strong consistency.

Changes

File Summary
docs/README.md Updated project description, emphasizing language-agnostic nature and database support. Added table of supported languages and capabilities.
docs/SUMMARY.md,
docs/running-tarmac/kvstore.md
Added "BoltDB" section to "Running Tarmac" documentation. Introduced "In-Memory" and "BoltDB" as new datastore options.

🐇💻

In the land of code where the shadows lie,

Tarmac stands tall, under the binary sky.

With each pull request, it grows ever so wise,

A beacon of knowledge in a coder's eyes.

New datastores join the noble quest,

To make Tarmac truly the best.

So here's to changes, big and small,

In the world of code, they benefit us all. 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 60fb3da and 825b394.
Files ignored due to filter (2)
  • docs/tarmac-architecture.png
  • docs/tarmac-logo.png
Files selected for processing (3)
  • docs/README.md (3 hunks)
  • docs/SUMMARY.md (1 hunks)
  • docs/running-tarmac/kvstore.md (1 hunks)
Files skipped from review due to trivial changes (3)
  • docs/README.md
  • docs/SUMMARY.md
  • docs/running-tarmac/kvstore.md

@madflojo madflojo merged commit d5e1475 into main Sep 24, 2023
@madflojo madflojo deleted the rebranding branch September 24, 2023 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant