Update README.md

This commit is contained in:
Michael Campagnaro 2021-03-24 12:30:31 -04:00
parent 3dff010f07
commit 829ebd0736
4 changed files with 24 additions and 14 deletions

2
.gitignore vendored
View File

@ -1,4 +1,4 @@
node_modules
.web-extension-id
sign.sh
web-ext-artifacts/
sign-firefox-extension.sh

View File

@ -1,30 +1,40 @@
Replaces YouTube comments with random herp derps. Click on the comment text to reveal the original.
This is modification of github.com/twstokes/herpderp
This is a fork of [twstokes/herpderp](https://github.com/twstokes/herpderp) with some modifications.
Note: Ignores iframe embedded videos, including the chat replay iframe on YouTube livestream vids.
**Known bugs**
1. As of 2021-03-24, sometimes when showing the original comment the first few lines are missing.
This tends to happen when you've transitioned to the page from another video. Refreshing the page
tends to fix the problem. I'll eventually try to fix this.
## Install
**Firefox**
* I have a signed xpi that you can immediately install. Open `build/` and drag the xpi into Firefox.
It may take a few seconds for the browser to display the extension installation dialog box.
* You can also find the signed Firefox files in the project's [Releases page](https://github.com/sir-pinecone/youtube-herp-derp-browser-extension/releases).
**Chrome**
* Unzip the Chrome addon file in the `build` folder.
* Go to Chrome extensions page. Toggle the developer mode (top-right of page). Click `Load
unpacked`.
* Select the unzipped folder.
* Go to Chrome extensions page.
* Toggle the developer mode (top-right of page).
* Click `Load unpacked`.
* Select this project's root folder.
## Development
### Local Testing
In Firefox, open about:debugging and click `Load Temporary Add-on...` then select `manifest.json`.
file.
* Firefox: open about:debugging and click `Load Temporary Add-on...` then select `manifest.json` file.
* Chrome: follow the install steps from above.
### Signing and Building
## Signing and Building
### Firefox
* Install web-ext with `$ npm install --global web-ext`
* Generate an unlisted xpi with:
'web-ext sign --channel unlisted --api-key <your add-on signing key> --api-secret <your add-on signing secret>`.
Those keys can be obtained from https://addons.mozilla.org/en-US/developers/addon/api/key/
* Drag downloaded xpi into Firefox.
`web-ext sign --api-key <your JWT issuer> --api-secret <your JWT secret>`
* You can obtain these keys from https://addons.mozilla.org/en-US/developers/addon/api/key/
* The signed xpi will be in `web-ext-artifacts/`. Drag this into Firefox to install it.
* Alternatively use the private sign-firefox-extension.sh script (not included in the repo) which places the xpi in `build/`.

View File

@ -2,7 +2,7 @@
"manifest_version": 2,
"name": "YouTube Herp Derp",
"description": "Replaces YouTube comments with herp derps. Forked from github.com/twstokes/herpderp",
"homepage_url": "https://michael.is",
"homepage_url": "https://github.com/sir-pinecone/youtube-herp-derp-browser-extension",
"version": "1.0.3",
"icons": {
"48": "icons/herp48.png",
@ -11,7 +11,7 @@
"content_scripts": [
{
"run_at": "document_idle",
"all_frames": false, // Ignore iframes.
"all_frames": false,
"matches": [
"https://apis.google.com/*",
"https://plus.googleapis.com/*",