diff --git a/README.md b/README.md index f631b0e..c300f92 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ # maubot_auto_youtube_preview -fork of [this maubot plugin](https://laboon.dev/brad/maubot-youtube) no longer requires !youtube will autodetect youtube.com or youtu.be links \ No newline at end of file +fork of [this maubot plugin](https://laboon.dev/brad/maubot-youtube) no longer requires !youtube will autodetect youtube.com or youtu.be links + +# maubot-youtube + +A [maubot](https://github.com/maubot/maubot) plugin to display YouTube video details. + +## Configuration +Before configuring your instance, you must first create an API token at the [Google Developer Console](https://console.developers.google.com) via the following steps: +1. Create a new project +2. Click "Enable APIs and Services", select the "YouTube Data API v3", and click "Enable" +3. Click "Create Credentials", select "YouTube Data API v3", and choose "Public data" and copy your key into the `api_key` config setting. + +Additionally, if you have URL previews enabled on your homeserver you may want to consider blacklisting youtube to prevent double previews. +Example config for synapse: +``` +url_preview_url_blacklist: + - netloc: 'youtube.com' + - netloc: 'www.youtube.com' + - netloc: 'youtu.be' +``` + +## Usage +Once configured, you can use send a youtube.com or youtu.be url to view the details of the specified video. + +## Building +Use the `mbc` tool to build this plugin: +``` +mbc build +``` +Optionally, use the `-u` switch to upload it to your maubot instance, if configured: +``` +mbc build -u +``` +Since `.mbp` files are just zip archives with a different name, you can also just zip the files of this repository: +``` +zip -r youtube.mbp * +``` + +## License + + +This project is licensed under the GNU Affero General Public License v3.0, see [LICENSE](LICENSE).