Add basic description in the README.

This commit is contained in:
Jonathan Bernard 2023-04-05 09:42:01 -05:00
parent 82dffc1154
commit 2a48974f3a

View File

@ -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*