Fix: Improved README documentation, fixed typos, and standardized badges#36
Fix: Improved README documentation, fixed typos, and standardized badges#36Humor-Haveli wants to merge 2 commits into
Conversation
I have made the following improvements to the README.md file: 1. Standardized the technology badges (Streamlit, MediaPipe, Python, SQLite) for better alignment. 2. Fixed a spelling mistake: changed 'challanage' to 'challenge'. 3. Replaced the LinkedIn contact section with a professional badge. 4. Improved the visual consistency of the overall documentation.
📝 WalkthroughWalkthroughThe README.md was revised: badge height attributes removed, the LinkedIn endorsement block replaced with a "Connect with me" badge/link, a typo fixed ("challanage" → "challenge"), the project overview expanded, and new "News Articles" and "Screenshots" sections were added with image references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 11: Change the heading "###### Connect with me:" to a higher-level
heading (e.g., "## Connect with me:" or "### Connect with me:") so the document
hierarchy follows H1 → H2/H3 instead of jumping to H6; locate the line
containing the literal "###### Connect with me:" in README.md and replace the
leading six hashes with two or three hashes to restore proper heading order.
- Line 42: Update the sentence in README.md that currently reads "this can be
very time consuming and given the number of people that go missing everyday" to
use the hyphenated adjective, the relative pronoun "who", and the correct "every
day" form; specifically replace "time consuming" with "time‑consuming", "people
that" with "people who", and "everyday" with "every day" so the sentence reads
e.g. "this can be very time‑consuming and given the number of people who go
missing every day..."
| ## What is the objective of this Project and how will it help? | ||
| The objective of this project is to help Police and higher authorities to track down missing people quickly. The usual process to track a person is using investigation which requires time and experience (to ask right questions). Most of the time, investigation method works pretty well but it is time consuming and can be unsuccessful if the person (missing) has been shifted/moved to different location (city/country).<br> | ||
| In such cases, the ideal approach is to go through CCTV footages and evidences. Again, this can be very time consuming and given the number of people that go missing everyday, it can be a challanage to keep up with it.<br> | ||
| In such cases, the ideal approach is to go through CCTV footages and evidences. Again, this can be very time consuming and given the number of people that go missing everyday, it can be a challenge to keep up with it.<br> |
There was a problem hiding this comment.
Polish sentence: “time‑consuming” and “people who”.
Suggested edit: “...this can be very time‑consuming and given the number of people who go missing every day...”
🧰 Tools
🪛 LanguageTool
[grammar] ~42-~42: Use a hyphen to join words.
Context: ... evidences. Again, this can be very time consuming and given the number of people...
(QB_NEW_EN_HYPHEN)
[style] ~42-~42: Consider using “who” when you are referring to people instead of objects.
Context: ...onsuming and given the number of people that go missing everyday, it can be a challe...
(THAT_WHO)
🤖 Prompt for AI Agents
In `@README.md` at line 42, Update the sentence in README.md that currently reads
"this can be very time consuming and given the number of people that go missing
everyday" to use the hyphenated adjective, the relative pronoun "who", and the
correct "every day" form; specifically replace "time consuming" with
"time‑consuming", "people that" with "people who", and "everyday" with "every
day" so the sentence reads e.g. "this can be very time‑consuming and given the
number of people who go missing every day..."
Corrected a minor error in the link and improved the overall formatting for better readability.
1 participant
I have made the following improvements to the README.md file: 1. Standardized the technology badges (Streamlit, MediaPipe, Python, SQLite) for better alignment. 2. Fixed a spelling mistake: changed 'challanage' to 'challenge'. 3. Replaced the LinkedIn contact section with a professional badge. 4. Improved the visual consistency of the overall documentation.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.