Add README and LICENSE

This commit is contained in:
2017-11-14 15:51:18 -08:00
parent 018770f711
commit 5328ade70e
2 changed files with 28 additions and 0 deletions

13
LICENSE Normal file
View File

@@ -0,0 +1,13 @@
Copyright (c) 2017 Adam Wick
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
# Overview
This is a simple library for parsing DER-encoded data.
In particular, this library automates the process of understanding the DER
encoded objects in an ASN.1 data stream. These tokens can then be parsed by your
library, based on the ASN.1 description in your format.
For convenience, we create the traits `ToASN1` and `FromASN` to abstract the
ability to decode a type from an ASN.1 token stream. If your type implements one
of these traits, your program or library can then use the convenience functions
`der_encode` and `der_decode` to do all the parsing work in one action.
Patches welcome!