Typo Update README.md

[famouswizard]

Description

This pull request addresses several minor typographical errors in the documentation, which collectively improve readability and clarity. The following changes have been made:

1. Section "🔧 Configuration":

   • Typo: "To getting started with Bandada, you can get rid of the configuration and just use the default settings."
   • Correction: "To get started with Bandada, you can skip the configuration and just use the default settings."
   • Importance: This change clarifies the intended meaning, making it easier for new users to understand setup instructions.

2. Section "🔌 API endpoints":

   • Typo: "APIs endpoints"
   • Correction: "API endpoints"
   • Importance: The corrected phrasing follows conventional terminology, which improves the technical accuracy and consistency of the document.

3. Section "👨‍💻 Contributing - Code quality and formatting":

   • Typo: "Run Prettier to check formatting rules."
   • Correction: "Use Prettier to check formatting rules."
   • Importance: This rephrasing makes it clear that Prettier is a tool to use, not an action to run, which better reflects its role in the workflow.

4. Section "👨‍💻 Contributing - Conventional commits":

   • Typo: "Bandada utilises conventional commits..."
   • Correction: "Bandada uses conventional commits..."
   • Importance: This change standardizes spelling for accessibility and broadens the documentation's usability for international readers.

5. Section "👨‍💻 Contributing - Releases":

   • Typo: "After pushing the new git tag, a workflow will be triggered and will publish the Bandada packages on npm and release a new version on Github with its changelogs automatically."
   • Correction: "After pushing the new git tag, a workflow will be triggered to publish the Bandada packages on npm and release a new version on GitHub with its changelogs automatically."
   • Importance: This revision clarifies the purpose and function of the automated workflow, reducing potential confusion for contributors managing releases.

Impact:
These corrections make the documentation more professional, clearer, and easier for users and contributors to follow. By improving these details, the documentation aligns better with Bandada’s commitment to quality and developer-friendly resources.

Does this introduce a breaking change?

• Yes
• No

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
bandada-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 15, 2024 7:55am
bandada-website	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 15, 2024 7:55am

[vplasencia]

Hey @famouswizard thank you very much for this PR. I just left some comments.

[gitpoap-bot]

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 Bandada Contributor:

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.