Skip to content

Commit abd3769

Browse files
committed
Update README to include install instructions
1 parent 3f5cf90 commit abd3769

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Vimeo integration
22
=================
33

4-
.. image:: https://raw.githubusercontent.com/pretalx/pretalx-vimeo/python-coverage-comment-action-data/badge.svg
5-
:target: https://htmlpreview.github.io/?https://github.com/pretalx/pretalx-vimeo/blob/python-coverage-comment-action-data/htmlcov/index.html
6-
:alt: Coverage
4+
.. image:: https://img.shields.io/pypi/v/pretalx-vimeo.svg
5+
:target: https://pypi.org/project/pretalx-vimeo/
6+
:alt: PyPI version
77

88
This is a plugin for `pretalx`_ that provides an integration with Vimeo, allowing you to embed recordings on talk pages.
99

@@ -12,6 +12,20 @@ This is a plugin for `pretalx`_ that provides an integration with Vimeo, allowin
1212
Additionally, the Plugin supplies an API at ``/api/events/<event>/p/vimeo/`` containing all configured Vimeo URLs, and
1313
an API at ``/api/events/<event>/submissions/<code>/p/vimeo/``, showing a submission's vimeo link.
1414

15+
Installation
16+
------------
17+
18+
Install the plugin with pip, in the same environment as your pretalx
19+
installation::
20+
21+
(env)$ python -m pip install pretalx-vimeo
22+
23+
Afterwards, run ``migrate`` and ``rebuild`` and restart your pretalx services,
24+
just like after any pretalx update (see `performing updates`_ in the
25+
administrator documentation).
26+
27+
You can then enable the plugin under "Settings → Plugins" in your event settings.
28+
1529
Development setup
1630
-----------------
1731

@@ -69,3 +83,4 @@ Released under the terms of the Apache License 2.0
6983
.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html
7084
.. _just: https://just.systems/
7185
.. _uv: https://docs.astral.sh/uv/
86+
.. _performing updates: https://docs.pretalx.org/administrator/maintenance/#performing-updates

0 commit comments

Comments
 (0)