feat: update readme files in repository

[ramraut-osm]

API PR Checklist

Pre-requisites

• I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
• I have performed preliminary unit testing.
• I have updated the required api docs as applicable.
• I have added/updated test cases to the test suite as applicable

PR Details

PR details have been updated as per the given format (see below)

• PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
• Description has been added
• Related changes have been added (optional)
• Screenshots have been added (optional)
• Query request and response examples have been added (as applicable, in case added or updated)
• Documentation changes have been listed (as applicable)
• Test suite output is added (as applicable)
• Pending actions have been added (optional)
• Any other additional notes have been added (optional)

Additional Information

• Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
• Assignee(s) and reviewer(s) have been added (optional)

---

Description:

Updated the readme files in the repository.

Related changes:

• Add short points about the different changes made within the files in this PR.

Screenshots:

Add any screenshots as required.

Query request and response:

• Add any query request body, cURL statement and response body for the made change or addition.

Documentation changes:

• Add a list of changes made to the API documents with brief descriptions.

Test suite output:

• Add the output of the status of different test cases in the testing suite.

Pending actions:

• Add list of any pending actions that have or would require to be done in this PR.

Additional notes:

• Add list of any additional notes you may want to convey in this PR.

Summary by CodeRabbit

• Documentation
  • Updated README to reflect the new application name: "Transcript Summarizer"
  • Revised content and descriptions to better explain application functionality and features.
  • Added detailed sections for project overview, key features, components, and contribution guidelines.

[coderabbitai]

Warning

Rate Limit Exceeded

@ramraut-osm has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 22 seconds before requesting another review.

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.

Commits

Files that changed from the base of the PR and between 4283574 and d0b3fae.

Walkthrough

The project underwent a transformation from osm-transcript-summarizer to Transcript Summarizer, featuring a revamped README.md. The changes include a new project title, refined description, enhanced features, components, and contribution guidelines to highlight the tool's capabilities and foster collaboration.

Changes

Files	Change Summary
README.md	Project renamed to Transcript Summarizer, updated descriptions, added new sections for clarity

In code we trust, with bytes we play,
A transcript tool to save the day.
From lines of text, we glean and learn,
Summaries concise, our new concern.
🐰✨ CodeRabbit hops, in joy we stay!

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 4

Out of diff range and nitpick comments (1)

apps/api/README.md (1)

1-1: Ensure the project title is consistent across all documentation.

Consider verifying that the project title "Transcript Summarizer" is consistently used in all related documentation and files.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9709a41 and b1db5f2.

Files selected for processing (1)

• apps/api/README.md (1 hunks)

[coderabbitai]

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b1db5f2 and 4bce4b7.

Files selected for processing (1)

• README.md (1 hunks)

Additional Context Used

LanguageTool (4)

README.md (4)

Near line 27: Unpaired symbol: ‘[’ seems to be missing
Context: ...of the following two components: 1. api, the backend of the applicati...

---

Near line 28: Unpaired symbol: ‘[’ seems to be missing
Context: ...he backend of the application 2. portal, the frontend of the appli...

---

Near line 30: Possible missing preposition found.
Context: ... the frontend of the application Refer the corresponding README files of these com...

---

Near line 52: The wording of this phrase can be improved.
Context: ...nd effort put in by all contributors to make this project better!

Additional comments not posted (7)

README.md (7)

1-3: The project title and welcome message updates are clear and concise.

---

5-5: The updated project description provides a clear and concise overview of the tool's functionality.

---

7-10: The "What It Does" section effectively explains the purpose and benefits of the tool.

---

11-15: The "Why Choose Us?" section clearly outlines the advantages of using the tool.

---

17-23: The "Key Features" section provides a clear and concise list of the tool's main features.

---

32-40: The "Contributing" section provides clear guidelines for contributions.

---

42-44: The "License" section provides clear licensing information.

[coderabbitai]

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4bce4b7 and 4283574.

Files selected for processing (1)

• README.md (1 hunks)

Additional Context Used

LanguageTool (3)

README.md (3)

Near line 28: Unpaired symbol: ‘[’ seems to be missing
Context: ...f the following two components: 1. api: the backend of the applicati...

---

Near line 29: Unpaired symbol: ‘[’ seems to be missing
Context: ...he backend of the application 2. portal: the frontend of the appli...

---

Near line 53: The wording of this phrase can be improved.
Context: ...nd effort put in by all contributors to make this project better!

Additional comments not posted (4)

README.md (4)

1-6: The project title and description updates are clear and well-written.

---

7-10: The "What It Does" section is concise and informative.

---

11-16: The "Why Choose Us?" section is well-organized and clearly states the benefits.

---

17-23: The "Key Features" section is well-presented and clearly lists the features.