diff options
| author | Ajay Ramachandran <[email protected]> | 2020-03-10 00:55:18 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2020-03-10 00:55:18 -0400 |
| commit | 140e324bf1d70b159caf09263a260167f0c373e1 (patch) | |
| tree | 8240a599394f01dbce9a05e7ab5ca40547b41dab | |
| parent | 6ccd4b8b37708fb193b1f7e2db5e474d74438aa4 (diff) | |
| download | SponsorBlock-140e324bf1d70b159caf09263a260167f0c373e1.tar.gz SponsorBlock-140e324bf1d70b159caf09263a260167f0c373e1.zip | |
Update README.md
| -rw-r--r-- | README.md | 24 |
1 files changed, 11 insertions, 13 deletions
@@ -40,31 +40,29 @@ The backend server code is available here: https://github.com/ajayyy/SponsorBloc It is a simple Sqlite database that will hold all the timing data. -To make sure that this project doesn't die, I have made the database publicly downloadable at https://api.sponsor.ajay.app/database.db. So, you can download a backup or get archive.org to take a backup for you if you want. +To make sure that this project doesn't die, I have made the database publicly downloadable at https://api.sponsor.ajay.app/database.db. You can download a backup or get archive.org to take a backup for you if you want. -Hopefully this project can be combined with projects like [this](https://github.com/Sponsoff/sponsorship_remover) and use this data to create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea. +The dataset and API are now being used [ports](https://github.com/ajayyy/SponsorBlock/wiki/Unofficial-Ports) as well as a [neural network](https://github.com/andrewzlee/NeuralBlock). + +A [previous project attempted to]((https://github.com/Sponsoff/sponsorship_remover) create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea starting from a crowd-sourced system instead. # API You can read the API docs [here](https://github.com/ajayyy/SponsorBlockServer#api-docs). -# Build Yourself - -You can load this project as an unpacked extension. Make sure to rename the `config.json.example` file to `config.json` before installing. +# Building -There are also other build scripts available. Install `npm`, then run `npm install` in the repository. +There are also other build scripts available. Install `npm`, then run `npm install` in the repository to install dependencies. -## Developing with a clean profile - -Run `npm run dev` to run the extension using a clean browser profile with hot reloading. Use `npm run dev:firefox` for Firefox. This uses [`web-ext run`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#commands). +Run `npm run build` to generate a Chrome extension. -## Packing +Use `npm run build:firefox` to generate a Firefox extension. -Run `npm run build` to generate a packed Chrome extension. +The result is in `dist`. This can be loaded as an unpacked extension -Use `npm run build:firefox` to generate a Firefox extension. +## Developing with a clean profile -The result is in `dist`. +Run `npm run dev` to run the extension using a clean browser profile with hot reloading. Use `npm run dev:firefox` for Firefox. This uses [`web-ext run`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#commands). # Credit |