aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4aa9e60
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+asn1kit
+=======
+
+asn1kit is an ASN.1 library written for Ruby.
+
+asn1kit parses a subset of the ASN.1:2015 [see below for what is supported] and
+supports encoding of the BER (Basic Encoding Rules) and DER (Distinguished
+Encoding Rules).
+
+What is supported by ASN1Kit
+----------------------------
+
+* Compiling ASN.1 module definition into Ruby objects
+* BER/DER decoding and DER encoding
+* TBA
+
+The level of support is sufficient to compile and process most of the PKIX
+modules.
+
+What is not supported by ASN1Kit
+--------------------------------
+
+* Constraints are not supported except the SizeConstraint.
+* XML value notation is not supported.
+* TBA
+
+How does the compiler work
+--------------------------
+
+The most part of the compiler is available in `lib/asn1kit/parse.ry` and
+`lib/asn1kit/compile.rb`.
+
+TBA