{"id":16964385,"url":"https://github.com/bolorundurowb/vcardlib","last_synced_at":"2025-12-27T06:44:35.654Z","repository":{"id":37276005,"uuid":"55345876","full_name":"bolorundurowb/vCardLib","owner":"bolorundurowb","description":"📇 A .NET standard library for reading and writing vCard files ","archived":false,"fork":false,"pushed_at":"2025-02-02T19:41:18.000Z","size":806,"stargazers_count":29,"open_issues_count":4,"forks_count":16,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-30T04:59:09.214Z","etag":null,"topics":["c-sharp","library","vcard","vcf"],"latest_commit_sha":null,"homepage":"https://github.com/bolorundurowb/vCardLib/blob/master/README.md","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bolorundurowb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"bolorundurowb"}},"created_at":"2016-04-03T12:44:35.000Z","updated_at":"2025-04-28T12:41:10.000Z","dependencies_parsed_at":"2025-02-09T00:15:44.887Z","dependency_job_id":null,"html_url":"https://github.com/bolorundurowb/vCardLib","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/bolorundurowb/vCardLib","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolorundurowb%2FvCardLib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolorundurowb%2FvCardLib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolorundurowb%2FvCardLib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolorundurowb%2FvCardLib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bolorundurowb","download_url":"https://codeload.github.com/bolorundurowb/vCardLib/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolorundurowb%2FvCardLib/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263176391,"owners_count":23425748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-sharp","library","vcard","vcf"],"created_at":"2024-10-13T23:43:27.107Z","updated_at":"2025-12-27T06:44:35.588Z","avatar_url":"https://github.com/bolorundurowb.png","language":"C#","funding_links":["https://patreon.com/bolorundurowb"],"categories":[],"sub_categories":[],"readme":"# vCardLib: A vCard (.vcf) Processing Library 📇\n\n![NuGet Version](https://img.shields.io/nuget/v/vCardLib.dll)  [![Coverage Status](https://coveralls.io/repos/github/bolorundurowb/vCardLib/badge.svg?branch=master)](https://coveralls.io/github/bolorundurowb/vCardLib?branch=master) \n[![NET Standard](https://img.shields.io/badge/netstandard-1.3-ff66b6.svg)]()  [![NET Standard](https://img.shields.io/badge/netstandard-2.0-3f76b1.svg)]()  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n---\n\n## About vCardLib 📜\n\n**vCardLib** is a powerful and flexible .NET library designed to simplify working with **vCard (.vcf)** files. Whether you're reading, writing, or manipulating contact information, **vCardLib** provides an easy-to-use API to handle vCard versions **2.1, 3.0, and 4.0** seamlessly. 🌟\n\nPerfect for applications dealing with contact management, address books, or any scenario where vCard files are used, **vCardLib** ensures your vCard processing is smooth and efficient. 🚀\n\n---\n\n## Features ✨\n\n- **Read Multiple Contacts**: Parse multiple contacts from a single `.vcf` file, stream, or string.\n- **Easy Iteration**: Returns contact data as an `IEnumerable\u003cvCard\u003e` for effortless looping.\n- **Cross-Version Support**: Works with vCard versions **2.1, 3.0, and 4.0**.\n- **Serialization and Deserialization**: Easily convert between vCard objects and their string/file representations.\n\n---\n\n## Installation 📦\n\nYou can install **vCardLib** via NuGet using one of the following methods:\n\n#### **Package Manager**\n```cmd\nInstall-Package vCardLib.dll\n```\n\n#### **.NET CLI**\n```bash\ndotnet add package vCardLib.dll\n```\n\n---\n\n## Usage 🛠️\n\n### Deserialization (Reading vCards)\n\n#### **From a File**\n```csharp\nstring filePath = // path to .vcf file;\nIEnumerable\u003cvCard\u003e contacts = vCardDeserializer.FromFile(filePath);\n```\n\n#### **From a Stream**\n```csharp\nvar stream = // generate stream containing serialized vCards\nIEnumerable\u003cvCard\u003e contacts = vCardDeserializer.FromStream(stream);\n```\n\n#### **From a String**\n```csharp\nvar contactDetails = @\"BEGIN:VCARD\nVERSION:2.1\nN:John;Doe;;;\nEND:VCARD\";\nIEnumerable\u003cvCard\u003e contacts = vCardDeserializer.FromContent(contactDetails);\n```\n\n---\n\n### Serialization (Writing vCards)\n\n#### **Serialize as String**\n```csharp\nvar vcard = new vCard(vCardVersion.V2)\n{\n    FormattedName = \"John Doe\"\n};\nvar serialized = vCardSerializer.Serialize(vcard);\n\n/*\nOutput:\nBEGIN:VCARD\nVERSION:2.1\nREV:20230719T001838Z\nFN:John Doe\nEND:VCARD\n*/\n```\n\n#### **Serialize with Version Override**\n```csharp\nvar vcard = new vCard(vCardVersion.V2)\n{\n    FormattedName = \"John Doe\"\n};\nvar serialized = vCardSerializer.Serialize(vcard, vCardVersion.V4);\n\n/*\nOutput:\nBEGIN:VCARD\nVERSION:4.0\nREV:20230719T001838Z\nFN:John Doe\nEND:VCARD\n*/\n```\n\n---\n\n## Branches 🌿\n\n- **`master`**: Contains the latest **breaking changes and features**. 🚧  \n  **Note:** This branch may contain unstable code and is not recommended for production use.\n\n- **[v4 Tag](https://github.com/bolorundurowb/vCardLib/tree/v4)**: The most recent stable release. ✅\n\n---\n\n## Contributors 🙌\n\nA huge thank you to these amazing contributors who have helped make **vCardLib** better:\n\n[@bolorundurowb](https://github.com/bolorundurowb), [@crowar](https://github.com/crowar),  \n[@rmja](https://github.com/rmja), [@JeanCollas](https://github.com/JeanCollas)\n\n---\n\n## License 📜\n\n**vCardLib** is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n\n---\n\n## Get Started Today! 🎉\n\nWhether you're building a contact management system, integrating vCard support into your app, or just need to process `.vcf` files, **vCardLib** is here to make your life easier. Install the package, follow the examples, and start working with vCards like a pro! ⏱️\n\n**Happy Coding!** 🚀","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbolorundurowb%2Fvcardlib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbolorundurowb%2Fvcardlib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbolorundurowb%2Fvcardlib/lists"}