-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README to fit other plugins formats
- Loading branch information
Vincent VERDEIL
committed
Oct 14, 2020
1 parent
a9d7151
commit a535969
Showing
2 changed files
with
49 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
NOTE: This plugin is ongoing and may not work yet. | ||
|
||
============== | ||
pibooth-qrcode | ||
============== | ||
|
||
|PythonVersions| |PypiPackage| |Downloads| | ||
|
||
``pibooth-qrcode`` is a plugin for the `pibooth`_ application. | ||
|
||
It adds the display of a custom qrcode at the print and wait state | ||
|
||
Install | ||
------- | ||
|
||
:: | ||
|
||
$ pip3 install pibooth-qrcode | ||
|
||
Configuration | ||
------------- | ||
|
||
Here below the new configuration options available in the `pibooth`_ configuration. | ||
**The keys and their default values are automatically added to your configuration after first** `pibooth`_ **restart.** | ||
|
||
.. code-block:: ini | ||
[QRCODE] | ||
# Prefix for the qrcode | ||
qrcode_prefix = "https://github.com/pibooth/pibooth" | ||
.. note:: Edit the configuration by running the command ``pibooth --config``. | ||
|
||
.. --- Links ------------------------------------------------------------------ | ||
.. _`pibooth`: https://pypi.org/project/pibooth | ||
|
||
.. |PythonVersions| image:: https://img.shields.io/badge/python-2.7+ / 3.6+-red.svg | ||
:target: https://www.python.org/downloads | ||
:alt: Python 2.7+/3.6+ | ||
|
||
.. |PypiPackage| image:: https://badge.fury.io/py/pibooth-qrcode.svg | ||
:target: https://pypi.org/project/pibooth-qrcode | ||
:alt: PyPi package | ||
|
||
.. |Downloads| image:: https://img.shields.io/pypi/dm/pibooth-qrcode?color=purple | ||
:target: https://pypi.org/project/pibooth-qrcode | ||
:alt: PyPi downloads |