diff --git a/docs/index.rst b/docs/index.rst index 062cc7a..bb36fc0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,19 +10,17 @@ NDEF Decoder and Encoder for Python The ``ndeflib`` is a Python package for parsing and generating NFC Data Exchange Format (NDEF) messages. It is licensed under the `ISCL`_, hosted on `GitHub`_ -and soon be available on `PyPI`_. - -.. code-block:: pycon - - >>> import ndef - >>> hexstr = '9101085402656e48656c6c6f5101085402656e576f726c64' - >>> octets = bytearray.fromhex(hexstr) - >>> for record in ndef.message_decoder(octets): print(record) - NDEF Text Record ID '' Text 'Hello' Language 'en' Encoding 'UTF-8' - NDEF Text Record ID '' Text 'World' Language 'en' Encoding 'UTF-8' - >>> message = [ndef.TextRecord("Hello"), ndef.TextRecord("World")] - >>> b''.join(ndef.message_encoder(message)) == octets - True +and can be installed from `PyPI`_. + +>>> import ndef +>>> hexstr = '9101085402656e48656c6c6f5101085402656e576f726c64' +>>> octets = bytearray.fromhex(hexstr) +>>> for record in ndef.message_decoder(octets): print(record) +NDEF Text Record ID '' Text 'Hello' Language 'en' Encoding 'UTF-8' +NDEF Text Record ID '' Text 'World' Language 'en' Encoding 'UTF-8' +>>> message = [ndef.TextRecord("Hello"), ndef.TextRecord("World")] +>>> b''.join(ndef.message_encoder(message)) == octets +True .. toctree:: :caption: Documentation