Skip to content
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

Update README.md #469

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

bhavishyaone
Copy link

  1. Table of Contents Added

    • Included a Table of Contents to help readers quickly find each section.
  2. Emojis for Better Look

    • Added a few emojis to make sections stand out and look more interesting.
  3. Clearer Section Titles

    • Updated titles to be clearer, like changing to What is Mimir? for a friendlier tone.

4.More Spacing for Easy Reading

  • Added extra lines and dividers between sections to make the text easier to read.
  1. Explained Structure Section

    • Gave a brief description of each part of Mimir (like Mimir, Mimir.Worker, MongoDB) before the diagram.
  2. Highlighted Example Link in Applications

    • Made the link in the Applications section easier to see and added some introductory text.
  3. Simple Language Edits

    • Rephrased some sentences for a smoother read and clearer meaning.

1. Table of Contents Added
   - Included a Table of Contents to help readers quickly find each 
      section.

2. Emojis for Better Look
   - Added a few emojis to make sections stand out and look more 
     interesting.

3. Clearer Section Titles
   - Updated titles to be clearer, like changing to What is Mimir? 
     for a friendlier tone.

4.More Spacing for Easy Reading
   - Added extra lines and dividers between sections to make the 
       text easier to read.

5. Explained Structure Section
   - Gave a brief description of each part of Mimir (like Mimir, 
       Mimir.Worker, MongoDB) before the diagram.

6. Highlighted Example Link in Applications
   - Made the link in the Applications section easier to see and 
      added some introductory text.

7. Simple Language Edits
   - Rephrased some sentences for a smoother read and clearer 
       meaning.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@boscohyun
Copy link
Member

@bhavishyaone Thanks for your kind contribute!

Please check this Contributor License Agreement!

> If you're new to Nine Chronicles, try to visit our **Developer Portal**!
>
> https://nine-chronicles.dev/
> ✨ **Tip:**
Copy link
Contributor

Choose a reason for hiding this comment

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

How do you think about this change? @boscohyun @Atralupus

Personally, I like GitHub-flavored markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

4 participants