Update README.md for clarity and detail on functionality and contribution guidelines
This commit is contained in:
parent
805da17f6b
commit
93bb743bc5
33
README.md
33
README.md
@ -1,21 +1,32 @@
|
|||||||
# ANTI-BS
|
# ANTI-BS
|
||||||
|
|
||||||
Simple YouTube member-video filter with a whitelist.
|
A small YouTube extension that hides member-only videos by default and supports a configurable whitelist.
|
||||||
|
Made by a squirrel, primarily for squirrels, but usable by anyone who prefers a cleaner feed.
|
||||||
|
|
||||||
## How it works
|
## How it works
|
||||||
|
|
||||||
- Member-only videos are detected and hidden by default.
|
* Member-only videos are detected and hidden automatically.
|
||||||
- A whitelist lets specific creators stay visible.
|
* A customizable whitelist allows selected creators’ videos to remain visible.
|
||||||
- Add both the display name and the channel link/handle.
|
* Each whitelist entry consists of the channel’s display name and its link or handle.
|
||||||
- If you are on a whitelisted channel page (like `https://www.youtube.com/@DaveMani/videos`),
|
* When visiting a whitelisted channel’s video page (for example, `https://www.youtube.com/@DaveMani/videos`),
|
||||||
nothing is hidden there.
|
no videos are hidden—sometimes it’s useful to see everything in one place.
|
||||||
|
|
||||||
## Whitelist input
|
## Whitelist input format
|
||||||
|
|
||||||
- Channel name: the visible name under the video (example: `Dave Mani`)
|
* **Channel name**: The visible name shown under the video (example: `Dave Mani`)
|
||||||
- Channel link or @handle: `@DaveMani` or `https://www.youtube.com/@DaveMani/videos`
|
* **Channel link or @handle**: Either an `@handle` (e.g. `@DaveMani`) or the full channel URL (e.g. `https://www.youtube.com/@DaveMani/videos`)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
MRs are allowed but mostly rejected. If you want to propose a change, open an MR
|
Merge requests are welcome, though the scope is intentionally kept small.
|
||||||
with a small, focused diff and explain the reason clearly.
|
If you’d like to contribute, please aim for:
|
||||||
|
|
||||||
|
* A focused, minimal change
|
||||||
|
* A clear explanation of what the change does and why
|
||||||
|
|
||||||
|
Large, unfocused feature additions may not be accepted.
|
||||||
|
|
||||||
|
## Special thanks
|
||||||
|
|
||||||
|
Thanks to [@DaveMani](https://www.youtube.com/@DaveMani)
|
||||||
|
The unusually high number of members-only videos on this channel made it a very effective real-world test case during development.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user