Properly raise version

[pyderasn.git] / README

diff --git a/README b/README
index 607fedc0df44b5fd4af1d2dcb3de9169bd0270bb..32c6db879dc9c7c9205c25ae082b23d2bc0a6ecb 100644 (file)
--- a/README
+++ b/README
@@ -1,27 +1,43 @@
-PyDERASN -- ASN.1 DER library for Python
+PyDERASN -- strict and fast ASN.1 DER/CER/BER library for Python

 
     I'm going to build my own ASN.1 library with slots and blobs!
     (C) PyDERASN's author
 
 
     I'm going to build my own ASN.1 library with slots and blobs!
     (C) PyDERASN's author
 

+* BER/CER/DER decoding, strict DER validation, DER/CER encoding

 * Basic ASN.1 data types (X.208): BOOLEAN, INTEGER, BIT STRING, OCTET
   STRING, NULL, OBJECT IDENTIFIER, ENUMERATED, all strings, UTCTime,
   GeneralizedTime, CHOICE, ANY, SEQUENCE (OF), SET (OF)
 * Size constraints checking
 * Working with sequences as high level data objects with ability to
   (un)marshall them
 * Basic ASN.1 data types (X.208): BOOLEAN, INTEGER, BIT STRING, OCTET
   STRING, NULL, OBJECT IDENTIFIER, ENUMERATED, all strings, UTCTime,
   GeneralizedTime, CHOICE, ANY, SEQUENCE (OF), SET (OF)
 * Size constraints checking
 * Working with sequences as high level data objects with ability to
   (un)marshall them

-* Python 2.7/3.5 compatibility
-* __slots__ friendliness
+* Aimed to be complaint with X.690-201508
+* Streaming decoding and encoding capabilities, allowing working with
+  very small memory footprint
+* Python 3.5+ compatibility
+* Automatic decoding of DEFINED BY fields

 * Ability to know exact decoded objects offset and lengths in the binary
 * Ability to know exact decoded objects offset and lengths in the binary

+* Ability to allow BER-encoded data with knowing if any of specified
+  field has either DER or BER encoding (or possibly indefinite-length
+  encoding)
+* Ability to use mmap-ed files, memoryviews, iterators, 2-pass DER
+  encoding mode and CER encoder dealing with the writer, giving ability
+  to create huge ASN.1 encoded files with very little memory footprint
+* Ability to decode files in event generation mode, without the need to
+  keep all the data and decoded structures in the memory
+* __slots__, copy.copy() friendliness
+* Workability with pickle
+* Cython compatibility
+* Descriptive errors, with decode paths

 * Pretty printer and command-line decoder, that could conveniently
   replace utilities like either dumpasn1 or openssl asn1parse
 
 pyderasn is free software: see the file COPYING.LESSER for copying conditions.
 
 * Pretty printer and command-line decoder, that could conveniently
   replace utilities like either dumpasn1 or openssl asn1parse
 
 pyderasn is free software: see the file COPYING.LESSER for copying conditions.
 

-PyDERASN home page is: http://pyderasn.cypherpunks.ru/
+PyDERASN home page is: http://www.pyderasn.cypherpunks.ru/

 
 Please send questions, bug reports and patches to
 
 Please send questions, bug reports and patches to

-https://lists.cypherpunks.ru/mailman/listinfo/pyderasn-devel
+http://lists.cypherpunks.ru/pyderasn_002ddevel.html

 mailing list. Announcements also go to this mailing list.
 
 Development Git source code repository currently is located here:
 mailing list. Announcements also go to this mailing list.
 
 Development Git source code repository currently is located here:

-https://git.cypherpunks.ru/cgit.cgi/pyderasn.git/
+http://www.git.cypherpunks.ru/?p=pyderasn.git;a=summary