Rewrite README with complete plain-text documentation#3
Open
Rewrite README with complete plain-text documentation#3
Conversation
… shiliaiwei profile link Agent-Logs-Url: https://github.com/shiliaiwei/Facebook/sessions/ec44976c-c10d-4972-ac50-1dd07997a6ec Co-authored-by: shiliaiwei <70220432+shiliaiwei@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README with usage instructions and author details
Rewrite README with complete plain-text documentation
Apr 3, 2026
shiliaiwei
approved these changes
Apr 4, 2026
There was a problem hiding this comment.
Pull request overview
Rewrites the repository README to provide complete, plain-text documentation of the Facebook Tools Suite, including tool behavior, internal logic, requirements, usage examples, applicability, ownership, and disclaimer.
Changes:
- Added clear “What It Does” and “How It Works” sections covering all three utilities.
- Documented installation requirements and step-by-step CLI usage with examples.
- Added platform scope (“Where to Use It”), rationale (“Why Use It”), and explicit ownership/maintainer info.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Example for downloading a video: | ||
| - Select option 1 | ||
| - Paste the Facebook video URL when prompted | ||
| - The downloaded file appears in ~/Videos/ |
There was a problem hiding this comment.
The example download location uses the Unix-style "~/Videos/" path, but the README also claims Windows support. Consider making the example path platform-neutral (e.g., "your home Videos folder") or include the Windows equivalent (like "%USERPROFILE%\Videos").
Suggested change
| - The downloaded file appears in ~/Videos/ | |
| - The downloaded file appears in the Videos folder in your home directory (for example, ~/Videos/ on Linux/macOS or %USERPROFILE%\Videos on Windows) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The existing README was incomplete — missing a title, installation instructions, and any explanation of how the code works internally. The problem statement requested a concise, plain-text summary covering code logic, usage, applicability, ownership, and a link to the repo owner's GitHub profile.
Changes
subprocess+yt-dlp,requests+ regex for user ID extraction,jsonfor metadata parsing,colorama/pyfigletfor terminal UIpip installcommands for all four dependencieshttps://github.com/shiliaiweiOriginal prompt