diff --git a/README.rst b/README.rst index 5db5ca4..83a0d57 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,31 @@ -Pretix Cash payment plugin +Pretix Cash Payment plugin ========================== -This is a plugin for `pretix`_. +This is a plugin for `pretix`_. + +Upon installation and activiation, you will be able to offer your clients a "Cash Payment"-option. This might be useful if you still want to sell tickets ahead of your event but the time to process payment transactions like SEPA-transfers is too long and/or payment via (credit) card processors is not possible or desired. + +In the plugin settings you can set a custom text which will not only be displayed to your customers when selecting the payment method but also after checkout has occured and the payment is pending as well as in the order-confirmation emails that are being sent out. + +Please note, that you will have to mark the orders as payed by hand using the pretix backend. You may also - at your own risk - use the `pretix-cashpoint`_ in conjunction with the `de.pccoholic.pretix.cashpoint`_ android app to mark tickets as payed. + +Production setup - pip method +----------------------------- + +1. Activate - if applicable your pretix `venv` + +2. ``pip install pretix-cashpayment`` + +3. python3 -m pretix migrate + +4. python3 -m pretix rebuild + +5. Restart your pretix processes: ``systemctl restart pretix-web pretix-worker`` + +Production setup - installation from git +---------------------------------------- + +Follow the instructions of the development setup. But instead of ``python setup.py develop`` in the plugin directory, run ``pip install .`` instead. ``python setup.py setup`` will not work. Development setup ----------------- @@ -30,3 +54,5 @@ Released under the terms of the Apache License 2.0 .. _pretix: https://github.com/pretix/pretix .. _pretix development setup: https://docs.pretix.eu/en/latest/development/setup.html +.. _pretix-cashpoint: https://github.com/pc-coholic/pretix-cashpoint +.. _de.pccoholic.pretix.cashpoint: https://github.com/pc-coholic/de.pccoholic.pretix.cashpoint