aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/plugins/subtitles/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'mediagoblin/plugins/subtitles/README.rst')
-rw-r--r--mediagoblin/plugins/subtitles/README.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/mediagoblin/plugins/subtitles/README.rst b/mediagoblin/plugins/subtitles/README.rst
new file mode 100644
index 00000000..c45b6c20
--- /dev/null
+++ b/mediagoblin/plugins/subtitles/README.rst
@@ -0,0 +1,25 @@
+================
+Subtitles plugin
+================
+
+This plugin enables text captioning of videos (though not yet audio). Once the
+plugin is enabled, you'll see a link to upload subtitles in `WebVTT format`_ as
+supported by the Video.js `Text Tracks`_ feature.
+
+.. _WebVTT format: https://en.wikipedia.org/wiki/WebVTT
+.. _Text Tracks: https://docs.videojs.com/docs/guides/text-tracks.html
+
+.. _subtitles-setup:
+
+Enabling the subtitles plugin
+=============================
+
+1. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section::
+
+ [[mediagoblin.plugins.subtitles]]
+
+2. Run::
+
+ $ ./bin/gmg dbupdate
+
+3. Restart your MediaGoblin process.