From 2a48974f3a31527158472bfa8e25499034a2c800 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Wed, 5 Apr 2023 09:42:01 -0500 Subject: [PATCH] Add basic description in the README. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ffbd132..2327e49 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ +# VCard + +`nim-vcard` is a purr-nim imolementation of the VCard format defined in RFCs +2425 and 2426. It allows you to parse and serialize VCards, as well as create +VCards programmatically. It aims to be a complete implememtation, supporting +all of the features of the VCard3 standard. Because the standard provides many +features that may be rarely used, this library also provides a simolified API +for more typical use-cases. + +## Future Goals + +* VCard 4.0 support + ## Debugging *Need to clean up and organize*