BER usage documentation

[pyderasn.git] / doc / index.rst

diff --git a/doc/index.rst b/doc/index.rst
index c99adb3076b0382aeb67c6070f492b6b085a4853..d1fca187f664e72ec1aa1d6da4bad8f2ddd0b357 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,6 +1,6 @@
-========================================
-PyDERASN -- ASN.1 DER library for Python
-========================================
+============================================
+PyDERASN -- ASN.1 DER/BER library for Python
+============================================
 
 ..
 
@@ -8,17 +8,22 @@ PyDERASN -- ASN.1 DER library for Python
     (C) PyDERASN's author
 
 `ASN.1 <https://en.wikipedia.org/wiki/ASN.1>`__ (Abstract Syntax
-Notation One) is a standard for abstract data serialization.
-`DER <https://en.wikipedia.org/wiki/Distinguished_Encoding_Rules>`__
-(Distinguished Encoding Rules) is a subset of encoding rules suitable
-and widely used in cryptography-related stuff. PyDERASN is yet another
-library for dealing with the data encoded that way. Although ASN.1 is
+Notation One) is a standard for abstract data serialization. PyDERASN is
+yet another library for dealing with ASN.1 structures, decoding them in
+`BER/CER/DER <https://en.wikipedia.org/wiki/X.690>`__ formats and
+encoding to DER (Distinguished Encoding Rules). Although ASN.1 is
 written more than 30 years ago by wise Ancients (taken from ``pyasn1``'s
 README), it is still often can be seen anywhere in our life.
 
 PyDERASN is `free software <https://www.gnu.org/philosophy/free-sw.html>`__,
 licenced under `GNU LGPLv3+ <https://www.gnu.org/licenses/lgpl-3.0.html>`__.
 
+.. figure:: pprinting.png
+   :alt: Pretty printing example output
+
+   An example of pretty printed X.509 certificate with automatically
+   parsed DEFINED BY fields.
+
 .. toctree::
    :maxdepth: 1
 
@@ -28,4 +33,5 @@ licenced under `GNU LGPLv3+ <https://www.gnu.org/licenses/lgpl-3.0.html>`__.
    news
    install
    download
+   thanks
    feedback